Package cloud.google.com/go/retail/apiv2beta/retailpb (v1.16.1)

Version latest

• 1.16.1 (latest)
• 1.16.0
• 1.15.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Variables

CatalogAttribute_AttributeType_name, CatalogAttribute_AttributeType_value

var (
	CatalogAttribute_AttributeType_name = map[int32]string{
		0: "UNKNOWN",
		1: "TEXTUAL",
		2: "NUMERICAL",
	}
	CatalogAttribute_AttributeType_value = map[string]int32{
		"UNKNOWN":   0,
		"TEXTUAL":   1,
		"NUMERICAL": 2,
	}
)

Enum value maps for CatalogAttribute_AttributeType.

CatalogAttribute_IndexableOption_name, CatalogAttribute_IndexableOption_value

var (
	CatalogAttribute_IndexableOption_name = map[int32]string{
		0: "INDEXABLE_OPTION_UNSPECIFIED",
		1: "INDEXABLE_ENABLED",
		2: "INDEXABLE_DISABLED",
	}
	CatalogAttribute_IndexableOption_value = map[string]int32{
		"INDEXABLE_OPTION_UNSPECIFIED": 0,
		"INDEXABLE_ENABLED":            1,
		"INDEXABLE_DISABLED":           2,
	}
)

Enum value maps for CatalogAttribute_IndexableOption.

CatalogAttribute_DynamicFacetableOption_name, CatalogAttribute_DynamicFacetableOption_value

var (
	CatalogAttribute_DynamicFacetableOption_name = map[int32]string{
		0: "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED",
		1: "DYNAMIC_FACETABLE_ENABLED",
		2: "DYNAMIC_FACETABLE_DISABLED",
	}
	CatalogAttribute_DynamicFacetableOption_value = map[string]int32{
		"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED": 0,
		"DYNAMIC_FACETABLE_ENABLED":            1,
		"DYNAMIC_FACETABLE_DISABLED":           2,
	}
)

Enum value maps for CatalogAttribute_DynamicFacetableOption.

CatalogAttribute_SearchableOption_name, CatalogAttribute_SearchableOption_value

var (
	CatalogAttribute_SearchableOption_name = map[int32]string{
		0: "SEARCHABLE_OPTION_UNSPECIFIED",
		1: "SEARCHABLE_ENABLED",
		2: "SEARCHABLE_DISABLED",
	}
	CatalogAttribute_SearchableOption_value = map[string]int32{
		"SEARCHABLE_OPTION_UNSPECIFIED": 0,
		"SEARCHABLE_ENABLED":            1,
		"SEARCHABLE_DISABLED":           2,
	}
)

Enum value maps for CatalogAttribute_SearchableOption.

CatalogAttribute_ExactSearchableOption_name, CatalogAttribute_ExactSearchableOption_value

var (
	CatalogAttribute_ExactSearchableOption_name = map[int32]string{
		0: "EXACT_SEARCHABLE_OPTION_UNSPECIFIED",
		1: "EXACT_SEARCHABLE_ENABLED",
		2: "EXACT_SEARCHABLE_DISABLED",
	}
	CatalogAttribute_ExactSearchableOption_value = map[string]int32{
		"EXACT_SEARCHABLE_OPTION_UNSPECIFIED": 0,
		"EXACT_SEARCHABLE_ENABLED":            1,
		"EXACT_SEARCHABLE_DISABLED":           2,
	}
)

Enum value maps for CatalogAttribute_ExactSearchableOption.

CatalogAttribute_RetrievableOption_name, CatalogAttribute_RetrievableOption_value

var (
	CatalogAttribute_RetrievableOption_name = map[int32]string{
		0: "RETRIEVABLE_OPTION_UNSPECIFIED",
		1: "RETRIEVABLE_ENABLED",
		2: "RETRIEVABLE_DISABLED",
	}
	CatalogAttribute_RetrievableOption_value = map[string]int32{
		"RETRIEVABLE_OPTION_UNSPECIFIED": 0,
		"RETRIEVABLE_ENABLED":            1,
		"RETRIEVABLE_DISABLED":           2,
	}
)

Enum value maps for CatalogAttribute_RetrievableOption.

AttributeConfigLevel_name, AttributeConfigLevel_value

var (
	AttributeConfigLevel_name = map[int32]string{
		0: "ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED",
		1: "PRODUCT_LEVEL_ATTRIBUTE_CONFIG",
		2: "CATALOG_LEVEL_ATTRIBUTE_CONFIG",
	}
	AttributeConfigLevel_value = map[string]int32{
		"ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED": 0,
		"PRODUCT_LEVEL_ATTRIBUTE_CONFIG":     1,
		"CATALOG_LEVEL_ATTRIBUTE_CONFIG":     2,
	}
)

Enum value maps for AttributeConfigLevel.

SolutionType_name, SolutionType_value

var (
	SolutionType_name = map[int32]string{
		0: "SOLUTION_TYPE_UNSPECIFIED",
		1: "SOLUTION_TYPE_RECOMMENDATION",
		2: "SOLUTION_TYPE_SEARCH",
	}
	SolutionType_value = map[string]int32{
		"SOLUTION_TYPE_UNSPECIFIED":    0,
		"SOLUTION_TYPE_RECOMMENDATION": 1,
		"SOLUTION_TYPE_SEARCH":         2,
	}
)

Enum value maps for SolutionType.

RecommendationsFilteringOption_name, RecommendationsFilteringOption_value

var (
	RecommendationsFilteringOption_name = map[int32]string{
		0: "RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED",
		1: "RECOMMENDATIONS_FILTERING_DISABLED",
		3: "RECOMMENDATIONS_FILTERING_ENABLED",
	}
	RecommendationsFilteringOption_value = map[string]int32{
		"RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED": 0,
		"RECOMMENDATIONS_FILTERING_DISABLED":           1,
		"RECOMMENDATIONS_FILTERING_ENABLED":            3,
	}
)

Enum value maps for RecommendationsFilteringOption.

SearchSolutionUseCase_name, SearchSolutionUseCase_value

var (
	SearchSolutionUseCase_name = map[int32]string{
		0: "SEARCH_SOLUTION_USE_CASE_UNSPECIFIED",
		1: "SEARCH_SOLUTION_USE_CASE_SEARCH",
		2: "SEARCH_SOLUTION_USE_CASE_BROWSE",
	}
	SearchSolutionUseCase_value = map[string]int32{
		"SEARCH_SOLUTION_USE_CASE_UNSPECIFIED": 0,
		"SEARCH_SOLUTION_USE_CASE_SEARCH":      1,
		"SEARCH_SOLUTION_USE_CASE_BROWSE":      2,
	}
)

Enum value maps for SearchSolutionUseCase.

ImportProductsRequest_ReconciliationMode_name, ImportProductsRequest_ReconciliationMode_value

var (
	ImportProductsRequest_ReconciliationMode_name = map[int32]string{
		0: "RECONCILIATION_MODE_UNSPECIFIED",
		1: "INCREMENTAL",
		2: "FULL",
	}
	ImportProductsRequest_ReconciliationMode_value = map[string]int32{
		"RECONCILIATION_MODE_UNSPECIFIED": 0,
		"INCREMENTAL":                     1,
		"FULL":                            2,
	}
)

Enum value maps for ImportProductsRequest_ReconciliationMode.

Model_ServingState_name, Model_ServingState_value

var (
	Model_ServingState_name = map[int32]string{
		0: "SERVING_STATE_UNSPECIFIED",
		1: "INACTIVE",
		2: "ACTIVE",
		3: "TUNED",
	}
	Model_ServingState_value = map[string]int32{
		"SERVING_STATE_UNSPECIFIED": 0,
		"INACTIVE":                  1,
		"ACTIVE":                    2,
		"TUNED":                     3,
	}
)

Enum value maps for Model_ServingState.

Model_TrainingState_name, Model_TrainingState_value

var (
	Model_TrainingState_name = map[int32]string{
		0: "TRAINING_STATE_UNSPECIFIED",
		1: "PAUSED",
		2: "TRAINING",
	}
	Model_TrainingState_value = map[string]int32{
		"TRAINING_STATE_UNSPECIFIED": 0,
		"PAUSED":                     1,
		"TRAINING":                   2,
	}
)

Enum value maps for Model_TrainingState.

Model_PeriodicTuningState_name, Model_PeriodicTuningState_value

var (
	Model_PeriodicTuningState_name = map[int32]string{
		0: "PERIODIC_TUNING_STATE_UNSPECIFIED",
		1: "PERIODIC_TUNING_DISABLED",
		3: "ALL_TUNING_DISABLED",
		2: "PERIODIC_TUNING_ENABLED",
	}
	Model_PeriodicTuningState_value = map[string]int32{
		"PERIODIC_TUNING_STATE_UNSPECIFIED": 0,
		"PERIODIC_TUNING_DISABLED":          1,
		"ALL_TUNING_DISABLED":               3,
		"PERIODIC_TUNING_ENABLED":           2,
	}
)

Enum value maps for Model_PeriodicTuningState.

Model_DataState_name, Model_DataState_value

var (
	Model_DataState_name = map[int32]string{
		0: "DATA_STATE_UNSPECIFIED",
		1: "DATA_OK",
		2: "DATA_ERROR",
	}
	Model_DataState_value = map[string]int32{
		"DATA_STATE_UNSPECIFIED": 0,
		"DATA_OK":                1,
		"DATA_ERROR":             2,
	}
)

Enum value maps for Model_DataState.

Product_Type_name, Product_Type_value

var (
	Product_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "PRIMARY",
		2: "VARIANT",
		3: "COLLECTION",
	}
	Product_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"PRIMARY":          1,
		"VARIANT":          2,
		"COLLECTION":       3,
	}
)

Enum value maps for Product_Type.

Product_Availability_name, Product_Availability_value

var (
	Product_Availability_name = map[int32]string{
		0: "AVAILABILITY_UNSPECIFIED",
		1: "IN_STOCK",
		2: "OUT_OF_STOCK",
		3: "PREORDER",
		4: "BACKORDER",
	}
	Product_Availability_value = map[string]int32{
		"AVAILABILITY_UNSPECIFIED": 0,
		"IN_STOCK":                 1,
		"OUT_OF_STOCK":             2,
		"PREORDER":                 3,
		"BACKORDER":                4,
	}
)

Enum value maps for Product_Availability.

SearchRequest_SearchMode_name, SearchRequest_SearchMode_value

var (
	SearchRequest_SearchMode_name = map[int32]string{
		0: "SEARCH_MODE_UNSPECIFIED",
		1: "PRODUCT_SEARCH_ONLY",
		2: "FACETED_SEARCH_ONLY",
	}
	SearchRequest_SearchMode_value = map[string]int32{
		"SEARCH_MODE_UNSPECIFIED": 0,
		"PRODUCT_SEARCH_ONLY":     1,
		"FACETED_SEARCH_ONLY":     2,
	}
)

Enum value maps for SearchRequest_SearchMode.

SearchRequest_DynamicFacetSpec_Mode_name, SearchRequest_DynamicFacetSpec_Mode_value

var (
	SearchRequest_DynamicFacetSpec_Mode_name = map[int32]string{
		0: "MODE_UNSPECIFIED",
		1: "DISABLED",
		2: "ENABLED",
	}
	SearchRequest_DynamicFacetSpec_Mode_value = map[string]int32{
		"MODE_UNSPECIFIED": 0,
		"DISABLED":         1,
		"ENABLED":          2,
	}
)

Enum value maps for SearchRequest_DynamicFacetSpec_Mode.

SearchRequest_QueryExpansionSpec_Condition_name, SearchRequest_QueryExpansionSpec_Condition_value

var (
	SearchRequest_QueryExpansionSpec_Condition_name = map[int32]string{
		0: "CONDITION_UNSPECIFIED",
		1: "DISABLED",
		3: "AUTO",
	}
	SearchRequest_QueryExpansionSpec_Condition_value = map[string]int32{
		"CONDITION_UNSPECIFIED": 0,
		"DISABLED":              1,
		"AUTO":                  3,
	}
)

Enum value maps for SearchRequest_QueryExpansionSpec_Condition.

SearchRequest_PersonalizationSpec_Mode_name, SearchRequest_PersonalizationSpec_Mode_value

var (
	SearchRequest_PersonalizationSpec_Mode_name = map[int32]string{
		0: "MODE_UNSPECIFIED",
		1: "AUTO",
		2: "DISABLED",
	}
	SearchRequest_PersonalizationSpec_Mode_value = map[string]int32{
		"MODE_UNSPECIFIED": 0,
		"AUTO":             1,
		"DISABLED":         2,
	}
)

Enum value maps for SearchRequest_PersonalizationSpec_Mode.

SearchRequest_SpellCorrectionSpec_Mode_name, SearchRequest_SpellCorrectionSpec_Mode_value

var (
	SearchRequest_SpellCorrectionSpec_Mode_name = map[int32]string{
		0: "MODE_UNSPECIFIED",
		1: "SUGGESTION_ONLY",
		2: "AUTO",
	}
	SearchRequest_SpellCorrectionSpec_Mode_value = map[string]int32{
		"MODE_UNSPECIFIED": 0,
		"SUGGESTION_ONLY":  1,
		"AUTO":             2,
	}
)

Enum value maps for SearchRequest_SpellCorrectionSpec_Mode.

ServingConfig_DiversityType_name, ServingConfig_DiversityType_value

var (
	ServingConfig_DiversityType_name = map[int32]string{
		0: "DIVERSITY_TYPE_UNSPECIFIED",
		2: "RULE_BASED_DIVERSITY",
		3: "DATA_DRIVEN_DIVERSITY",
	}
	ServingConfig_DiversityType_value = map[string]int32{
		"DIVERSITY_TYPE_UNSPECIFIED": 0,
		"RULE_BASED_DIVERSITY":       2,
		"DATA_DRIVEN_DIVERSITY":      3,
	}
)

Enum value maps for ServingConfig_DiversityType.

RejoinUserEventsRequest_UserEventRejoinScope_name, RejoinUserEventsRequest_UserEventRejoinScope_value

var (
	RejoinUserEventsRequest_UserEventRejoinScope_name = map[int32]string{
		0: "USER_EVENT_REJOIN_SCOPE_UNSPECIFIED",
		1: "JOINED_EVENTS",
		2: "UNJOINED_EVENTS",
	}
	RejoinUserEventsRequest_UserEventRejoinScope_value = map[string]int32{
		"USER_EVENT_REJOIN_SCOPE_UNSPECIFIED": 0,
		"JOINED_EVENTS":                       1,
		"UNJOINED_EVENTS":                     2,
	}
)

Enum value maps for RejoinUserEventsRequest_UserEventRejoinScope.

File_google_cloud_retail_v2beta_analytics_service_proto

var File_google_cloud_retail_v2beta_analytics_service_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_catalog_proto

var File_google_cloud_retail_v2beta_catalog_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_catalog_service_proto

var File_google_cloud_retail_v2beta_catalog_service_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_common_proto

var File_google_cloud_retail_v2beta_common_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_completion_service_proto

var File_google_cloud_retail_v2beta_completion_service_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_control_proto

var File_google_cloud_retail_v2beta_control_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_control_service_proto

var File_google_cloud_retail_v2beta_control_service_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_export_config_proto

var File_google_cloud_retail_v2beta_export_config_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_import_config_proto

var File_google_cloud_retail_v2beta_import_config_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_model_proto

var File_google_cloud_retail_v2beta_model_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_model_service_proto

var File_google_cloud_retail_v2beta_model_service_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_prediction_service_proto

var File_google_cloud_retail_v2beta_prediction_service_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_product_proto

var File_google_cloud_retail_v2beta_product_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_product_service_proto

var File_google_cloud_retail_v2beta_product_service_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_promotion_proto

var File_google_cloud_retail_v2beta_promotion_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_purge_config_proto

var File_google_cloud_retail_v2beta_purge_config_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_search_service_proto

var File_google_cloud_retail_v2beta_search_service_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_serving_config_proto

var File_google_cloud_retail_v2beta_serving_config_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_serving_config_service_proto

var File_google_cloud_retail_v2beta_serving_config_service_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_user_event_proto

var File_google_cloud_retail_v2beta_user_event_proto protoreflect.FileDescriptor

File_google_cloud_retail_v2beta_user_event_service_proto

var File_google_cloud_retail_v2beta_user_event_service_proto protoreflect.FileDescriptor

Functions

func RegisterAnalyticsServiceServer

func RegisterAnalyticsServiceServer(s *grpc.Server, srv AnalyticsServiceServer)

func RegisterCatalogServiceServer

func RegisterCatalogServiceServer(s *grpc.Server, srv CatalogServiceServer)

func RegisterCompletionServiceServer

func RegisterCompletionServiceServer(s *grpc.Server, srv CompletionServiceServer)

func RegisterControlServiceServer

func RegisterControlServiceServer(s *grpc.Server, srv ControlServiceServer)

func RegisterModelServiceServer

func RegisterModelServiceServer(s *grpc.Server, srv ModelServiceServer)

func RegisterPredictionServiceServer

func RegisterPredictionServiceServer(s *grpc.Server, srv PredictionServiceServer)

func RegisterProductServiceServer

func RegisterProductServiceServer(s *grpc.Server, srv ProductServiceServer)

func RegisterSearchServiceServer

func RegisterSearchServiceServer(s *grpc.Server, srv SearchServiceServer)

func RegisterServingConfigServiceServer

func RegisterServingConfigServiceServer(s *grpc.Server, srv ServingConfigServiceServer)

func RegisterUserEventServiceServer

func RegisterUserEventServiceServer(s *grpc.Server, srv UserEventServiceServer)

AddCatalogAttributeRequest

type AddCatalogAttributeRequest struct {

	// Required. Full AttributesConfig resource name. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
	AttributesConfig string `protobuf:"bytes,1,opt,name=attributes_config,json=attributesConfig,proto3" json:"attributes_config,omitempty"`
	// Required. The
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to add.
	CatalogAttribute *CatalogAttribute `protobuf:"bytes,2,opt,name=catalog_attribute,json=catalogAttribute,proto3" json:"catalog_attribute,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.AddCatalogAttribute][google.cloud.retail.v2beta.CatalogService.AddCatalogAttribute] method.

func (*AddCatalogAttributeRequest) Descriptor

func (*AddCatalogAttributeRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddCatalogAttributeRequest.ProtoReflect.Descriptor instead.

func (*AddCatalogAttributeRequest) GetAttributesConfig

func (x *AddCatalogAttributeRequest) GetAttributesConfig() string

func (*AddCatalogAttributeRequest) GetCatalogAttribute

func (x *AddCatalogAttributeRequest) GetCatalogAttribute() *CatalogAttribute

func (*AddCatalogAttributeRequest) ProtoMessage

func (*AddCatalogAttributeRequest) ProtoMessage()

func (*AddCatalogAttributeRequest) ProtoReflect

func (x *AddCatalogAttributeRequest) ProtoReflect() protoreflect.Message

func (*AddCatalogAttributeRequest) Reset

func (x *AddCatalogAttributeRequest) Reset()

func (*AddCatalogAttributeRequest) String

func (x *AddCatalogAttributeRequest) String() string

AddControlRequest

type AddControlRequest struct {

	// Required. The source ServingConfig resource name . Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
	ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// Required. The id of the control to apply. Assumed to be in the same catalog
	// as the serving config - if id is not found a NOT_FOUND error is returned.
	ControlId string `protobuf:"bytes,2,opt,name=control_id,json=controlId,proto3" json:"control_id,omitempty"`
	// contains filtered or unexported fields
}

Request for AddControl method.

func (*AddControlRequest) Descriptor

func (*AddControlRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddControlRequest.ProtoReflect.Descriptor instead.

func (*AddControlRequest) GetControlId

func (x *AddControlRequest) GetControlId() string

func (*AddControlRequest) GetServingConfig

func (x *AddControlRequest) GetServingConfig() string

func (*AddControlRequest) ProtoMessage

func (*AddControlRequest) ProtoMessage()

func (*AddControlRequest) ProtoReflect

func (x *AddControlRequest) ProtoReflect() protoreflect.Message

func (*AddControlRequest) Reset

func (x *AddControlRequest) Reset()

func (*AddControlRequest) String

func (x *AddControlRequest) String() string

AddFulfillmentPlacesMetadata

type AddFulfillmentPlacesMetadata struct {
	// contains filtered or unexported fields
}

Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces] method.

func (*AddFulfillmentPlacesMetadata) Descriptor

func (*AddFulfillmentPlacesMetadata) Descriptor() ([]byte, []int)

Deprecated: Use AddFulfillmentPlacesMetadata.ProtoReflect.Descriptor instead.

func (*AddFulfillmentPlacesMetadata) ProtoMessage

func (*AddFulfillmentPlacesMetadata) ProtoMessage()

func (*AddFulfillmentPlacesMetadata) ProtoReflect

func (x *AddFulfillmentPlacesMetadata) ProtoReflect() protoreflect.Message

func (*AddFulfillmentPlacesMetadata) Reset

func (x *AddFulfillmentPlacesMetadata) Reset()

func (*AddFulfillmentPlacesMetadata) String

func (x *AddFulfillmentPlacesMetadata) String() string

AddFulfillmentPlacesRequest

type AddFulfillmentPlacesRequest struct {

	// Required. Full resource name of
	// [Product][google.cloud.retail.v2beta.Product], such as
	// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
	//
	// If the caller does not have permission to access the
	// [Product][google.cloud.retail.v2beta.Product], regardless of whether or not
	// it exists, a PERMISSION_DENIED error is returned.
	Product string `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
	// Required. The fulfillment type, including commonly used types (such as
	// pickup in store and same day delivery), and custom types.
	//
	// Supported values:
	//
	// * "pickup-in-store"
	// * "ship-to-store"
	// * "same-day-delivery"
	// * "next-day-delivery"
	// * "custom-type-1"
	// * "custom-type-2"
	// * "custom-type-3"
	// * "custom-type-4"
	// * "custom-type-5"
	//
	// If this field is set to an invalid value other than these, an
	// INVALID_ARGUMENT error is returned.
	//
	// This field directly corresponds to
	// [Product.fulfillment_info.type][google.cloud.retail.v2beta.FulfillmentInfo.type].
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Required. The IDs for this
	// [type][google.cloud.retail.v2beta.AddFulfillmentPlacesRequest.type], such
	// as the store IDs for "pickup-in-store" or the region IDs for
	// "same-day-delivery" to be added for this
	// [type][google.cloud.retail.v2beta.AddFulfillmentPlacesRequest.type].
	// Duplicate IDs will be automatically ignored.
	//
	// At least 1 value is required, and a maximum of 2000 values are allowed.
	// Each value must be a string with a length limit of 10 characters, matching
	// the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
	// INVALID_ARGUMENT error is returned.
	//
	// If the total number of place IDs exceeds 2000 for this
	// [type][google.cloud.retail.v2beta.AddFulfillmentPlacesRequest.type] after
	// adding, then the update will be rejected.
	PlaceIds []string `protobuf:"bytes,3,rep,name=place_ids,json=placeIds,proto3" json:"place_ids,omitempty"`
	// The time when the fulfillment updates are issued, used to prevent
	// out-of-order updates on fulfillment information. If not provided, the
	// internal system time will be used.
	AddTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=add_time,json=addTime,proto3" json:"add_time,omitempty"`
	// If set to true, and the [Product][google.cloud.retail.v2beta.Product] is
	// not found, the fulfillment information will still be processed and retained
	// for at most 1 day and processed once the
	// [Product][google.cloud.retail.v2beta.Product] is created. If set to false,
	// a NOT_FOUND error is returned if the
	// [Product][google.cloud.retail.v2beta.Product] is not found.
	AllowMissing bool `protobuf:"varint,5,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces] method.

func (*AddFulfillmentPlacesRequest) Descriptor

func (*AddFulfillmentPlacesRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddFulfillmentPlacesRequest.ProtoReflect.Descriptor instead.

func (*AddFulfillmentPlacesRequest) GetAddTime

func (x *AddFulfillmentPlacesRequest) GetAddTime() *timestamppb.Timestamp

func (*AddFulfillmentPlacesRequest) GetAllowMissing

func (x *AddFulfillmentPlacesRequest) GetAllowMissing() bool

func (*AddFulfillmentPlacesRequest) GetPlaceIds

func (x *AddFulfillmentPlacesRequest) GetPlaceIds() []string

func (*AddFulfillmentPlacesRequest) GetProduct

func (x *AddFulfillmentPlacesRequest) GetProduct() string

func (*AddFulfillmentPlacesRequest) GetType

func (x *AddFulfillmentPlacesRequest) GetType() string

func (*AddFulfillmentPlacesRequest) ProtoMessage

func (*AddFulfillmentPlacesRequest) ProtoMessage()

func (*AddFulfillmentPlacesRequest) ProtoReflect

func (x *AddFulfillmentPlacesRequest) ProtoReflect() protoreflect.Message

func (*AddFulfillmentPlacesRequest) Reset

func (x *AddFulfillmentPlacesRequest) Reset()

func (*AddFulfillmentPlacesRequest) String

func (x *AddFulfillmentPlacesRequest) String() string

AddFulfillmentPlacesResponse

type AddFulfillmentPlacesResponse struct {
	// contains filtered or unexported fields
}

Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces] method.

func (*AddFulfillmentPlacesResponse) Descriptor

func (*AddFulfillmentPlacesResponse) Descriptor() ([]byte, []int)

Deprecated: Use AddFulfillmentPlacesResponse.ProtoReflect.Descriptor instead.

func (*AddFulfillmentPlacesResponse) ProtoMessage

func (*AddFulfillmentPlacesResponse) ProtoMessage()

func (*AddFulfillmentPlacesResponse) ProtoReflect

func (x *AddFulfillmentPlacesResponse) ProtoReflect() protoreflect.Message

func (*AddFulfillmentPlacesResponse) Reset

func (x *AddFulfillmentPlacesResponse) Reset()

func (*AddFulfillmentPlacesResponse) String

func (x *AddFulfillmentPlacesResponse) String() string

AddLocalInventoriesMetadata

type AddLocalInventoriesMetadata struct {
	// contains filtered or unexported fields
}

Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] method.

func (*AddLocalInventoriesMetadata) Descriptor

func (*AddLocalInventoriesMetadata) Descriptor() ([]byte, []int)

Deprecated: Use AddLocalInventoriesMetadata.ProtoReflect.Descriptor instead.

func (*AddLocalInventoriesMetadata) ProtoMessage

func (*AddLocalInventoriesMetadata) ProtoMessage()

func (*AddLocalInventoriesMetadata) ProtoReflect

func (x *AddLocalInventoriesMetadata) ProtoReflect() protoreflect.Message

func (*AddLocalInventoriesMetadata) Reset

func (x *AddLocalInventoriesMetadata) Reset()

func (*AddLocalInventoriesMetadata) String

func (x *AddLocalInventoriesMetadata) String() string

AddLocalInventoriesRequest

type AddLocalInventoriesRequest struct {

	// Required. Full resource name of
	// [Product][google.cloud.retail.v2beta.Product], such as
	// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
	//
	// If the caller does not have permission to access the
	// [Product][google.cloud.retail.v2beta.Product], regardless of whether or not
	// it exists, a PERMISSION_DENIED error is returned.
	Product string `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
	// Required. A list of inventory information at difference places. Each place
	// is identified by its place ID. At most 3000 inventories are allowed per
	// request.
	LocalInventories []*LocalInventory `protobuf:"bytes,2,rep,name=local_inventories,json=localInventories,proto3" json:"local_inventories,omitempty"`
	// Indicates which inventory fields in the provided list of
	// [LocalInventory][google.cloud.retail.v2beta.LocalInventory] to update. The
	// field is updated to the provided value.
	//
	// If a field is set while the place does not have a previous local inventory,
	// the local inventory at that store is created.
	//
	// If a field is set while the value of that field is not provided, the
	// original field value, if it exists, is deleted.
	//
	// If the mask is not set or set with empty paths, all inventory fields will
	// be updated.
	//
	// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
	// is returned and the entire update will be ignored.
	AddMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=add_mask,json=addMask,proto3" json:"add_mask,omitempty"`
	// The time when the inventory updates are issued. Used to prevent
	// out-of-order updates on local inventory fields. If not provided, the
	// internal system time will be used.
	AddTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=add_time,json=addTime,proto3" json:"add_time,omitempty"`
	// If set to true, and the [Product][google.cloud.retail.v2beta.Product] is
	// not found, the local inventory will still be processed and retained for at
	// most 1 day and processed once the
	// [Product][google.cloud.retail.v2beta.Product] is created. If set to false,
	// a NOT_FOUND error is returned if the
	// [Product][google.cloud.retail.v2beta.Product] is not found.
	AllowMissing bool `protobuf:"varint,6,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] method.

func (*AddLocalInventoriesRequest) Descriptor

func (*AddLocalInventoriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddLocalInventoriesRequest.ProtoReflect.Descriptor instead.

func (*AddLocalInventoriesRequest) GetAddMask

func (x *AddLocalInventoriesRequest) GetAddMask() *fieldmaskpb.FieldMask

func (*AddLocalInventoriesRequest) GetAddTime

func (x *AddLocalInventoriesRequest) GetAddTime() *timestamppb.Timestamp

func (*AddLocalInventoriesRequest) GetAllowMissing

func (x *AddLocalInventoriesRequest) GetAllowMissing() bool

func (*AddLocalInventoriesRequest) GetLocalInventories

func (x *AddLocalInventoriesRequest) GetLocalInventories() []*LocalInventory

func (*AddLocalInventoriesRequest) GetProduct

func (x *AddLocalInventoriesRequest) GetProduct() string

func (*AddLocalInventoriesRequest) ProtoMessage

func (*AddLocalInventoriesRequest) ProtoMessage()

func (*AddLocalInventoriesRequest) ProtoReflect

func (x *AddLocalInventoriesRequest) ProtoReflect() protoreflect.Message

func (*AddLocalInventoriesRequest) Reset

func (x *AddLocalInventoriesRequest) Reset()

func (*AddLocalInventoriesRequest) String

func (x *AddLocalInventoriesRequest) String() string

AddLocalInventoriesResponse

type AddLocalInventoriesResponse struct {
	// contains filtered or unexported fields
}

Response of the [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] API. Currently empty because there is no meaningful response populated from the [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] method.

func (*AddLocalInventoriesResponse) Descriptor

func (*AddLocalInventoriesResponse) Descriptor() ([]byte, []int)

Deprecated: Use AddLocalInventoriesResponse.ProtoReflect.Descriptor instead.

func (*AddLocalInventoriesResponse) ProtoMessage

func (*AddLocalInventoriesResponse) ProtoMessage()

func (*AddLocalInventoriesResponse) ProtoReflect

func (x *AddLocalInventoriesResponse) ProtoReflect() protoreflect.Message

func (*AddLocalInventoriesResponse) Reset

func (x *AddLocalInventoriesResponse) Reset()

func (*AddLocalInventoriesResponse) String

func (x *AddLocalInventoriesResponse) String() string

AnalyticsServiceClient

type AnalyticsServiceClient interface {
	// Exports analytics metrics.
	//
	// `Operation.response` is of type `ExportAnalyticsMetricsResponse`.
	// `Operation.metadata` is of type `ExportMetadata`.
	ExportAnalyticsMetrics(ctx context.Context, in *ExportAnalyticsMetricsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

AnalyticsServiceClient is the client API for AnalyticsService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAnalyticsServiceClient

func NewAnalyticsServiceClient(cc grpc.ClientConnInterface) AnalyticsServiceClient

AnalyticsServiceServer

type AnalyticsServiceServer interface {
	// Exports analytics metrics.
	//
	// `Operation.response` is of type `ExportAnalyticsMetricsResponse`.
	// `Operation.metadata` is of type `ExportMetadata`.
	ExportAnalyticsMetrics(context.Context, *ExportAnalyticsMetricsRequest) (*longrunningpb.Operation, error)
}

AnalyticsServiceServer is the server API for AnalyticsService service.

AttributeConfigLevel

type AttributeConfigLevel int32

At which level we offer configuration for attributes.

AttributeConfigLevel_ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED, AttributeConfigLevel_PRODUCT_LEVEL_ATTRIBUTE_CONFIG, AttributeConfigLevel_CATALOG_LEVEL_ATTRIBUTE_CONFIG

const (
	// Value used when unset. In this case, server behavior defaults to
	// [CATALOG_LEVEL_ATTRIBUTE_CONFIG][google.cloud.retail.v2beta.AttributeConfigLevel.CATALOG_LEVEL_ATTRIBUTE_CONFIG].
	AttributeConfigLevel_ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED AttributeConfigLevel = 0
	// At this level, we honor the attribute configurations set in
	// [Product.attributes][google.cloud.retail.v2beta.Product.attributes].
	AttributeConfigLevel_PRODUCT_LEVEL_ATTRIBUTE_CONFIG AttributeConfigLevel = 1
	// At this level, we honor the attribute configurations set in
	// [CatalogConfig.attribute_configs][].
	AttributeConfigLevel_CATALOG_LEVEL_ATTRIBUTE_CONFIG AttributeConfigLevel = 2
)

func (AttributeConfigLevel) Descriptor

func (AttributeConfigLevel) Descriptor() protoreflect.EnumDescriptor

func (AttributeConfigLevel) Enum

func (x AttributeConfigLevel) Enum() *AttributeConfigLevel

func (AttributeConfigLevel) EnumDescriptor

func (AttributeConfigLevel) EnumDescriptor() ([]byte, []int)

Deprecated: Use AttributeConfigLevel.Descriptor instead.

func (AttributeConfigLevel) Number

func (x AttributeConfigLevel) Number() protoreflect.EnumNumber

func (AttributeConfigLevel) String

func (x AttributeConfigLevel) String() string

func (AttributeConfigLevel) Type

func (AttributeConfigLevel) Type() protoreflect.EnumType

AttributesConfig

type AttributesConfig struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	CatalogAttributes map[string]*CatalogAttribute "" /* 200 byte string literal not displayed */

	AttributeConfigLevel AttributeConfigLevel "" /* 177 byte string literal not displayed */

}

Catalog level attribute config.

func (*AttributesConfig) Descriptor

func (*AttributesConfig) Descriptor() ([]byte, []int)

Deprecated: Use AttributesConfig.ProtoReflect.Descriptor instead.

func (*AttributesConfig) GetAttributeConfigLevel

func (x *AttributesConfig) GetAttributeConfigLevel() AttributeConfigLevel

func (*AttributesConfig) GetCatalogAttributes

func (x *AttributesConfig) GetCatalogAttributes() map[string]*CatalogAttribute

func (*AttributesConfig) GetName

func (x *AttributesConfig) GetName() string

func (*AttributesConfig) ProtoMessage

func (*AttributesConfig) ProtoMessage()

func (*AttributesConfig) ProtoReflect

func (x *AttributesConfig) ProtoReflect() protoreflect.Message

func (*AttributesConfig) Reset

func (x *AttributesConfig) Reset()

func (*AttributesConfig) String

func (x *AttributesConfig) String() string

Audience

type Audience struct {

	// The genders of the audience. Strongly encouraged to use the standard
	// values: "male", "female", "unisex".
	//
	// At most 5 values are allowed. Each value must be a UTF-8 encoded string
	// with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error
	// is returned.
	//
	// Google Merchant Center property
	// [gender](https://support.google.com/merchants/answer/6324479). Schema.org
	// property
	// [Product.audience.suggestedGender](https://schema.org/suggestedGender).
	Genders []string `protobuf:"bytes,1,rep,name=genders,proto3" json:"genders,omitempty"`
	// The age groups of the audience. Strongly encouraged to use the standard
	// values: "newborn" (up to 3 months old), "infant" (3–12 months old),
	// "toddler" (1–5 years old), "kids" (5–13 years old), "adult" (typically
	// teens or older).
	//
	// At most 5 values are allowed. Each value must be a UTF-8 encoded string
	// with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error
	// is returned.
	//
	// Google Merchant Center property
	// [age_group](https://support.google.com/merchants/answer/6324463).
	// Schema.org property
	// [Product.audience.suggestedMinAge](https://schema.org/suggestedMinAge) and
	// [Product.audience.suggestedMaxAge](https://schema.org/suggestedMaxAge).
	AgeGroups []string `protobuf:"bytes,2,rep,name=age_groups,json=ageGroups,proto3" json:"age_groups,omitempty"`
	// contains filtered or unexported fields
}

An intended audience of the [Product][google.cloud.retail.v2beta.Product] for whom it's sold.

func (*Audience) Descriptor

func (*Audience) Descriptor() ([]byte, []int)

Deprecated: Use Audience.ProtoReflect.Descriptor instead.

func (*Audience) GetAgeGroups

func (x *Audience) GetAgeGroups() []string

func (*Audience) GetGenders

func (x *Audience) GetGenders() []string

func (*Audience) ProtoMessage

func (*Audience) ProtoMessage()

func (*Audience) ProtoReflect

func (x *Audience) ProtoReflect() protoreflect.Message

func (*Audience) Reset

func (x *Audience) Reset()

func (*Audience) String

func (x *Audience) String() string

BatchRemoveCatalogAttributesRequest

type BatchRemoveCatalogAttributesRequest struct {

	// Required. The attributes config resource shared by all catalog attributes
	// being deleted. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
	AttributesConfig string `protobuf:"bytes,1,opt,name=attributes_config,json=attributesConfig,proto3" json:"attributes_config,omitempty"`
	// Required. The attribute name keys of the
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s to delete.
	// A maximum of 1000 catalog attributes can be deleted in a batch.
	AttributeKeys []string `protobuf:"bytes,2,rep,name=attribute_keys,json=attributeKeys,proto3" json:"attribute_keys,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2beta.CatalogService.BatchRemoveCatalogAttributes] method.

func (*BatchRemoveCatalogAttributesRequest) Descriptor

func (*BatchRemoveCatalogAttributesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchRemoveCatalogAttributesRequest.ProtoReflect.Descriptor instead.

func (*BatchRemoveCatalogAttributesRequest) GetAttributeKeys

func (x *BatchRemoveCatalogAttributesRequest) GetAttributeKeys() []string

func (*BatchRemoveCatalogAttributesRequest) GetAttributesConfig

func (x *BatchRemoveCatalogAttributesRequest) GetAttributesConfig() string

func (*BatchRemoveCatalogAttributesRequest) ProtoMessage

func (*BatchRemoveCatalogAttributesRequest) ProtoMessage()

func (*BatchRemoveCatalogAttributesRequest) ProtoReflect

func (x *BatchRemoveCatalogAttributesRequest) ProtoReflect() protoreflect.Message

func (*BatchRemoveCatalogAttributesRequest) Reset

func (x *BatchRemoveCatalogAttributesRequest) Reset()

func (*BatchRemoveCatalogAttributesRequest) String

func (x *BatchRemoveCatalogAttributesRequest) String() string

BatchRemoveCatalogAttributesResponse

type BatchRemoveCatalogAttributesResponse struct {
	DeletedCatalogAttributes []string "" /* 135 byte string literal not displayed */

	ResetCatalogAttributes []string "" /* 129 byte string literal not displayed */

}

Response of the [CatalogService.BatchRemoveCatalogAttributes][google.cloud.retail.v2beta.CatalogService.BatchRemoveCatalogAttributes].

func (*BatchRemoveCatalogAttributesResponse) Descriptor

func (*BatchRemoveCatalogAttributesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchRemoveCatalogAttributesResponse.ProtoReflect.Descriptor instead.

func (*BatchRemoveCatalogAttributesResponse) GetDeletedCatalogAttributes

func (x *BatchRemoveCatalogAttributesResponse) GetDeletedCatalogAttributes() []string

func (*BatchRemoveCatalogAttributesResponse) GetResetCatalogAttributes

func (x *BatchRemoveCatalogAttributesResponse) GetResetCatalogAttributes() []string

func (*BatchRemoveCatalogAttributesResponse) ProtoMessage

func (*BatchRemoveCatalogAttributesResponse) ProtoMessage()

func (*BatchRemoveCatalogAttributesResponse) ProtoReflect

func (x *BatchRemoveCatalogAttributesResponse) ProtoReflect() protoreflect.Message

func (*BatchRemoveCatalogAttributesResponse) Reset

func (x *BatchRemoveCatalogAttributesResponse) Reset()

func (*BatchRemoveCatalogAttributesResponse) String

func (x *BatchRemoveCatalogAttributesResponse) String() string

BigQueryOutputResult

type BigQueryOutputResult struct {

	// The ID of a BigQuery Dataset.
	DatasetId string `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// The ID of a BigQuery Table.
	TableId string `protobuf:"bytes,2,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// contains filtered or unexported fields
}

A BigQuery output result.

func (*BigQueryOutputResult) Descriptor

func (*BigQueryOutputResult) Descriptor() ([]byte, []int)

Deprecated: Use BigQueryOutputResult.ProtoReflect.Descriptor instead.

func (*BigQueryOutputResult) GetDatasetId

func (x *BigQueryOutputResult) GetDatasetId() string

func (*BigQueryOutputResult) GetTableId

func (x *BigQueryOutputResult) GetTableId() string

func (*BigQueryOutputResult) ProtoMessage

func (*BigQueryOutputResult) ProtoMessage()

func (*BigQueryOutputResult) ProtoReflect

func (x *BigQueryOutputResult) ProtoReflect() protoreflect.Message

func (*BigQueryOutputResult) Reset

func (x *BigQueryOutputResult) Reset()

func (*BigQueryOutputResult) String

func (x *BigQueryOutputResult) String() string

BigQuerySource

type BigQuerySource struct {

	// BigQuery table partition info. Leave this empty if the BigQuery table
	// is not partitioned.
	//
	// Types that are assignable to Partition:
	//
	//	*BigQuerySource_PartitionDate
	Partition isBigQuerySource_Partition `protobuf_oneof:"partition"`
	// The project ID (can be project # or ID) that the BigQuery source is in with
	// a length limit of 128 characters. If not specified, inherits the project
	// ID from the parent request.
	ProjectId string `protobuf:"bytes,5,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The BigQuery data set to copy the data from with a length limit
	// of 1,024 characters.
	DatasetId string `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// Required. The BigQuery table to copy the data from with a length limit of
	// 1,024 characters.
	TableId string `protobuf:"bytes,2,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// Intermediate Cloud Storage directory used for the import with a length
	// limit of 2,000 characters. Can be specified if one wants to have the
	// BigQuery export to a specific Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,3,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// The schema to use when parsing the data from the source.
	//
	// Supported values for product imports:
	//
	// * `product` (default): One JSON
	// [Product][google.cloud.retail.v2beta.Product] per line. Each product must
	//
	//	have a valid [Product.id][google.cloud.retail.v2beta.Product.id].
	//   - `product_merchant_center`: See [Importing catalog data from Merchant
	//     Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
	//
	// Supported values for user events imports:
	//
	// * `user_event` (default): One JSON
	// [UserEvent][google.cloud.retail.v2beta.UserEvent] per line.
	//   - `user_event_ga360`:
	//     The schema is available here:
	//     https://support.google.com/analytics/answer/3437719.
	//   - `user_event_ga4`:
	//     The schema is available here:
	//     https://support.google.com/analytics/answer/7029846.
	//
	// Supported values for autocomplete imports:
	//
	// * `suggestions` (default): One JSON completion suggestion per line.
	// * `denylist`:  One JSON deny suggestion per line.
	// * `allowlist`:  One JSON allow suggestion per line.
	DataSchema string `protobuf:"bytes,4,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
	// contains filtered or unexported fields
}

BigQuery source import data from.

func (*BigQuerySource) Descriptor

func (*BigQuerySource) Descriptor() ([]byte, []int)

Deprecated: Use BigQuerySource.ProtoReflect.Descriptor instead.

func (*BigQuerySource) GetDataSchema

func (x *BigQuerySource) GetDataSchema() string

func (*BigQuerySource) GetDatasetId

func (x *BigQuerySource) GetDatasetId() string

func (*BigQuerySource) GetGcsStagingDir

func (x *BigQuerySource) GetGcsStagingDir() string

func (*BigQuerySource) GetPartition

func (m *BigQuerySource) GetPartition() isBigQuerySource_Partition

func (*BigQuerySource) GetPartitionDate

func (x *BigQuerySource) GetPartitionDate() *date.Date

func (*BigQuerySource) GetProjectId

func (x *BigQuerySource) GetProjectId() string

func (*BigQuerySource) GetTableId

func (x *BigQuerySource) GetTableId() string

func (*BigQuerySource) ProtoMessage

func (*BigQuerySource) ProtoMessage()

func (*BigQuerySource) ProtoReflect

func (x *BigQuerySource) ProtoReflect() protoreflect.Message

func (*BigQuerySource) Reset

func (x *BigQuerySource) Reset()

func (*BigQuerySource) String

func (x *BigQuerySource) String() string

BigQuerySource_PartitionDate

type BigQuerySource_PartitionDate struct {
	// BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
	//
	// Only supported in
	// [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest].
	PartitionDate *date.Date `protobuf:"bytes,6,opt,name=partition_date,json=partitionDate,proto3,oneof"`
}

Catalog

type Catalog struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`

	ProductLevelConfig *ProductLevelConfig `protobuf:"bytes,4,opt,name=product_level_config,json=productLevelConfig,proto3" json:"product_level_config,omitempty"`

	MerchantCenterLinkingConfig *MerchantCenterLinkingConfig "" /* 146 byte string literal not displayed */

}

The catalog configuration.

func (*Catalog) Descriptor

func (*Catalog) Descriptor() ([]byte, []int)

Deprecated: Use Catalog.ProtoReflect.Descriptor instead.

func (*Catalog) GetDisplayName

func (x *Catalog) GetDisplayName() string

func (*Catalog) GetMerchantCenterLinkingConfig

func (x *Catalog) GetMerchantCenterLinkingConfig() *MerchantCenterLinkingConfig

func (*Catalog) GetName

func (x *Catalog) GetName() string

func (*Catalog) GetProductLevelConfig

func (x *Catalog) GetProductLevelConfig() *ProductLevelConfig

func (*Catalog) ProtoMessage

func (*Catalog) ProtoMessage()

func (*Catalog) ProtoReflect

func (x *Catalog) ProtoReflect() protoreflect.Message

func (*Catalog) Reset

func (x *Catalog) Reset()

func (*Catalog) String

func (x *Catalog) String() string

CatalogAttribute

type CatalogAttribute struct {
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`

	InUse bool `protobuf:"varint,9,opt,name=in_use,json=inUse,proto3" json:"in_use,omitempty"`

	Type CatalogAttribute_AttributeType `protobuf:"varint,10,opt,name=type,proto3,enum=google.cloud.retail.v2beta.CatalogAttribute_AttributeType" json:"type,omitempty"`

	IndexableOption CatalogAttribute_IndexableOption "" /* 172 byte string literal not displayed */

	DynamicFacetableOption CatalogAttribute_DynamicFacetableOption "" /* 202 byte string literal not displayed */

	SearchableOption CatalogAttribute_SearchableOption "" /* 176 byte string literal not displayed */

	RecommendationsFilteringOption RecommendationsFilteringOption "" /* 217 byte string literal not displayed */

	ExactSearchableOption CatalogAttribute_ExactSearchableOption "" /* 199 byte string literal not displayed */

	RetrievableOption CatalogAttribute_RetrievableOption "" /* 181 byte string literal not displayed */

}

Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.

func (*CatalogAttribute) Descriptor

func (*CatalogAttribute) Descriptor() ([]byte, []int)

Deprecated: Use CatalogAttribute.ProtoReflect.Descriptor instead.

func (*CatalogAttribute) GetDynamicFacetableOption

func (x *CatalogAttribute) GetDynamicFacetableOption() CatalogAttribute_DynamicFacetableOption

func (*CatalogAttribute) GetExactSearchableOption

func (x *CatalogAttribute) GetExactSearchableOption() CatalogAttribute_ExactSearchableOption

func (*CatalogAttribute) GetInUse

func (x *CatalogAttribute) GetInUse() bool

func (*CatalogAttribute) GetIndexableOption

func (x *CatalogAttribute) GetIndexableOption() CatalogAttribute_IndexableOption

func (*CatalogAttribute) GetKey

func (x *CatalogAttribute) GetKey() string

func (*CatalogAttribute) GetRecommendationsFilteringOption

func (x *CatalogAttribute) GetRecommendationsFilteringOption() RecommendationsFilteringOption

func (*CatalogAttribute) GetRetrievableOption

func (x *CatalogAttribute) GetRetrievableOption() CatalogAttribute_RetrievableOption

func (*CatalogAttribute) GetSearchableOption

func (x *CatalogAttribute) GetSearchableOption() CatalogAttribute_SearchableOption

func (*CatalogAttribute) GetType

func (x *CatalogAttribute) GetType() CatalogAttribute_AttributeType

func (*CatalogAttribute) ProtoMessage

func (*CatalogAttribute) ProtoMessage()

func (*CatalogAttribute) ProtoReflect

func (x *CatalogAttribute) ProtoReflect() protoreflect.Message

func (*CatalogAttribute) Reset

func (x *CatalogAttribute) Reset()

func (*CatalogAttribute) String

func (x *CatalogAttribute) String() string

CatalogAttribute_AttributeType

type CatalogAttribute_AttributeType int32

The type of an attribute.

CatalogAttribute_UNKNOWN, CatalogAttribute_TEXTUAL, CatalogAttribute_NUMERICAL

const (
	// The type of the attribute is unknown.
	//
	// Used when type cannot be derived from attribute that is not
	// [in_use][google.cloud.retail.v2beta.CatalogAttribute.in_use].
	CatalogAttribute_UNKNOWN CatalogAttribute_AttributeType = 0
	// Textual attribute.
	CatalogAttribute_TEXTUAL CatalogAttribute_AttributeType = 1
	// Numerical attribute.
	CatalogAttribute_NUMERICAL CatalogAttribute_AttributeType = 2
)

func (CatalogAttribute_AttributeType) Descriptor

func (CatalogAttribute_AttributeType) Descriptor() protoreflect.EnumDescriptor

func (CatalogAttribute_AttributeType) Enum

func (x CatalogAttribute_AttributeType) Enum() *CatalogAttribute_AttributeType

func (CatalogAttribute_AttributeType) EnumDescriptor

func (CatalogAttribute_AttributeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use CatalogAttribute_AttributeType.Descriptor instead.

func (CatalogAttribute_AttributeType) Number

func (x CatalogAttribute_AttributeType) Number() protoreflect.EnumNumber

func (CatalogAttribute_AttributeType) String

func (x CatalogAttribute_AttributeType) String() string

func (CatalogAttribute_AttributeType) Type

func (CatalogAttribute_AttributeType) Type() protoreflect.EnumType

CatalogAttribute_DynamicFacetableOption

type CatalogAttribute_DynamicFacetableOption int32

The status of the dynamic facetable option of a catalog attribute.

CatalogAttribute_DYNAMIC_FACETABLE_OPTION_UNSPECIFIED, CatalogAttribute_DYNAMIC_FACETABLE_ENABLED, CatalogAttribute_DYNAMIC_FACETABLE_DISABLED

const (
	// Value used when unset.
	CatalogAttribute_DYNAMIC_FACETABLE_OPTION_UNSPECIFIED CatalogAttribute_DynamicFacetableOption = 0
	// Dynamic facetable option enabled for an attribute.
	CatalogAttribute_DYNAMIC_FACETABLE_ENABLED CatalogAttribute_DynamicFacetableOption = 1
	// Dynamic facetable option disabled for an attribute.
	CatalogAttribute_DYNAMIC_FACETABLE_DISABLED CatalogAttribute_DynamicFacetableOption = 2
)

func (CatalogAttribute_DynamicFacetableOption) Descriptor

func (CatalogAttribute_DynamicFacetableOption) Descriptor() protoreflect.EnumDescriptor

func (CatalogAttribute_DynamicFacetableOption) Enum

func (x CatalogAttribute_DynamicFacetableOption) Enum() *CatalogAttribute_DynamicFacetableOption

func (CatalogAttribute_DynamicFacetableOption) EnumDescriptor

func (CatalogAttribute_DynamicFacetableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use CatalogAttribute_DynamicFacetableOption.Descriptor instead.

func (CatalogAttribute_DynamicFacetableOption) Number

func (x CatalogAttribute_DynamicFacetableOption) Number() protoreflect.EnumNumber

func (CatalogAttribute_DynamicFacetableOption) String

func (x CatalogAttribute_DynamicFacetableOption) String() string

func (CatalogAttribute_DynamicFacetableOption) Type

func (CatalogAttribute_DynamicFacetableOption) Type() protoreflect.EnumType

CatalogAttribute_ExactSearchableOption

type CatalogAttribute_ExactSearchableOption int32

The status of the exact-searchable option of a catalog attribute.

CatalogAttribute_EXACT_SEARCHABLE_OPTION_UNSPECIFIED, CatalogAttribute_EXACT_SEARCHABLE_ENABLED, CatalogAttribute_EXACT_SEARCHABLE_DISABLED

const (
	// Value used when unset.
	CatalogAttribute_EXACT_SEARCHABLE_OPTION_UNSPECIFIED CatalogAttribute_ExactSearchableOption = 0
	// Exact searchable option enabled for an attribute.
	CatalogAttribute_EXACT_SEARCHABLE_ENABLED CatalogAttribute_ExactSearchableOption = 1
	// Exact searchable option disabled for an attribute.
	CatalogAttribute_EXACT_SEARCHABLE_DISABLED CatalogAttribute_ExactSearchableOption = 2
)

func (CatalogAttribute_ExactSearchableOption) Descriptor

func (CatalogAttribute_ExactSearchableOption) Descriptor() protoreflect.EnumDescriptor

func (CatalogAttribute_ExactSearchableOption) Enum

func (x CatalogAttribute_ExactSearchableOption) Enum() *CatalogAttribute_ExactSearchableOption

func (CatalogAttribute_ExactSearchableOption) EnumDescriptor

func (CatalogAttribute_ExactSearchableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use CatalogAttribute_ExactSearchableOption.Descriptor instead.

func (CatalogAttribute_ExactSearchableOption) Number

func (x CatalogAttribute_ExactSearchableOption) Number() protoreflect.EnumNumber

func (CatalogAttribute_ExactSearchableOption) String

func (x CatalogAttribute_ExactSearchableOption) String() string

func (CatalogAttribute_ExactSearchableOption) Type

func (CatalogAttribute_ExactSearchableOption) Type() protoreflect.EnumType

CatalogAttribute_IndexableOption

type CatalogAttribute_IndexableOption int32

The status of the indexable option of a catalog attribute.

CatalogAttribute_INDEXABLE_OPTION_UNSPECIFIED, CatalogAttribute_INDEXABLE_ENABLED, CatalogAttribute_INDEXABLE_DISABLED

const (
	// Value used when unset.
	CatalogAttribute_INDEXABLE_OPTION_UNSPECIFIED CatalogAttribute_IndexableOption = 0
	// Indexable option enabled for an attribute.
	CatalogAttribute_INDEXABLE_ENABLED CatalogAttribute_IndexableOption = 1
	// Indexable option disabled for an attribute.
	CatalogAttribute_INDEXABLE_DISABLED CatalogAttribute_IndexableOption = 2
)

func (CatalogAttribute_IndexableOption) Descriptor

func (CatalogAttribute_IndexableOption) Descriptor() protoreflect.EnumDescriptor

func (CatalogAttribute_IndexableOption) Enum

func (x CatalogAttribute_IndexableOption) Enum() *CatalogAttribute_IndexableOption

func (CatalogAttribute_IndexableOption) EnumDescriptor

func (CatalogAttribute_IndexableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use CatalogAttribute_IndexableOption.Descriptor instead.

func (CatalogAttribute_IndexableOption) Number

func (x CatalogAttribute_IndexableOption) Number() protoreflect.EnumNumber

func (CatalogAttribute_IndexableOption) String

func (x CatalogAttribute_IndexableOption) String() string

func (CatalogAttribute_IndexableOption) Type

func (CatalogAttribute_IndexableOption) Type() protoreflect.EnumType

CatalogAttribute_RetrievableOption

type CatalogAttribute_RetrievableOption int32

The status of the retrievable option of a catalog attribute.

CatalogAttribute_RETRIEVABLE_OPTION_UNSPECIFIED, CatalogAttribute_RETRIEVABLE_ENABLED, CatalogAttribute_RETRIEVABLE_DISABLED

const (
	// Value used when unset.
	CatalogAttribute_RETRIEVABLE_OPTION_UNSPECIFIED CatalogAttribute_RetrievableOption = 0
	// Retrievable option enabled for an attribute.
	CatalogAttribute_RETRIEVABLE_ENABLED CatalogAttribute_RetrievableOption = 1
	// Retrievable option disabled for an attribute.
	CatalogAttribute_RETRIEVABLE_DISABLED CatalogAttribute_RetrievableOption = 2
)

func (CatalogAttribute_RetrievableOption) Descriptor

func (CatalogAttribute_RetrievableOption) Descriptor() protoreflect.EnumDescriptor

func (CatalogAttribute_RetrievableOption) Enum

func (x CatalogAttribute_RetrievableOption) Enum() *CatalogAttribute_RetrievableOption

func (CatalogAttribute_RetrievableOption) EnumDescriptor

func (CatalogAttribute_RetrievableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use CatalogAttribute_RetrievableOption.Descriptor instead.

func (CatalogAttribute_RetrievableOption) Number

func (x CatalogAttribute_RetrievableOption) Number() protoreflect.EnumNumber

func (CatalogAttribute_RetrievableOption) String

func (x CatalogAttribute_RetrievableOption) String() string

func (CatalogAttribute_RetrievableOption) Type

func (CatalogAttribute_RetrievableOption) Type() protoreflect.EnumType

CatalogAttribute_SearchableOption

type CatalogAttribute_SearchableOption int32

The status of the searchable option of a catalog attribute.

CatalogAttribute_SEARCHABLE_OPTION_UNSPECIFIED, CatalogAttribute_SEARCHABLE_ENABLED, CatalogAttribute_SEARCHABLE_DISABLED

const (
	// Value used when unset.
	CatalogAttribute_SEARCHABLE_OPTION_UNSPECIFIED CatalogAttribute_SearchableOption = 0
	// Searchable option enabled for an attribute.
	CatalogAttribute_SEARCHABLE_ENABLED CatalogAttribute_SearchableOption = 1
	// Searchable option disabled for an attribute.
	CatalogAttribute_SEARCHABLE_DISABLED CatalogAttribute_SearchableOption = 2
)

func (CatalogAttribute_SearchableOption) Descriptor

func (CatalogAttribute_SearchableOption) Descriptor() protoreflect.EnumDescriptor

func (CatalogAttribute_SearchableOption) Enum

func (x CatalogAttribute_SearchableOption) Enum() *CatalogAttribute_SearchableOption

func (CatalogAttribute_SearchableOption) EnumDescriptor

func (CatalogAttribute_SearchableOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use CatalogAttribute_SearchableOption.Descriptor instead.

func (CatalogAttribute_SearchableOption) Number

func (x CatalogAttribute_SearchableOption) Number() protoreflect.EnumNumber

func (CatalogAttribute_SearchableOption) String

func (x CatalogAttribute_SearchableOption) String() string

func (CatalogAttribute_SearchableOption) Type

func (CatalogAttribute_SearchableOption) Type() protoreflect.EnumType

CatalogServiceClient

type CatalogServiceClient interface {
	// Lists all the [Catalog][google.cloud.retail.v2beta.Catalog]s associated
	// with the project.
	ListCatalogs(ctx context.Context, in *ListCatalogsRequest, opts ...grpc.CallOption) (*ListCatalogsResponse, error)
	// Updates the [Catalog][google.cloud.retail.v2beta.Catalog]s.
	UpdateCatalog(ctx context.Context, in *UpdateCatalogRequest, opts ...grpc.CallOption) (*Catalog, error)
	// Set a specified branch id as default branch. API methods such as
	// [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search],
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct],
	// [ProductService.ListProducts][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchRequest.branch] to
	// `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent
	// to setting
	// [SearchRequest.branch][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.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}.
	SetDefaultBranch(ctx context.Context, in *SetDefaultBranchRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Get which branch is currently default branch set by
	// [CatalogService.SetDefaultBranch][google.cloud.retail.v2beta.CatalogService.SetDefaultBranch]
	// method under a specified parent catalog.
	GetDefaultBranch(ctx context.Context, in *GetDefaultBranchRequest, opts ...grpc.CallOption) (*GetDefaultBranchResponse, error)
	// Gets a [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig].
	GetCompletionConfig(ctx context.Context, in *GetCompletionConfigRequest, opts ...grpc.CallOption) (*CompletionConfig, error)
	// Updates the
	// [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig]s.
	UpdateCompletionConfig(ctx context.Context, in *UpdateCompletionConfigRequest, opts ...grpc.CallOption) (*CompletionConfig, error)
	// Gets an [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
	GetAttributesConfig(ctx context.Context, in *GetAttributesConfigRequest, opts ...grpc.CallOption) (*AttributesConfig, error)
	// Updates the
	// [AttributesConfig][google.cloud.retail.v2beta.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.
	UpdateAttributesConfig(ctx context.Context, in *UpdateAttributesConfigRequest, opts ...grpc.CallOption) (*AttributesConfig, error)
	// Adds the specified
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to the
	// [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
	//
	// If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to
	// add already exists, an ALREADY_EXISTS error is returned.
	AddCatalogAttribute(ctx context.Context, in *AddCatalogAttributeRequest, opts ...grpc.CallOption) (*AttributesConfig, error)
	// Removes the specified
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] from the
	// [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
	//
	// If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to
	// remove does not exist, a NOT_FOUND error is returned.
	RemoveCatalogAttribute(ctx context.Context, in *RemoveCatalogAttributeRequest, opts ...grpc.CallOption) (*AttributesConfig, error)
	// Removes all specified
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s from the
	// [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
	BatchRemoveCatalogAttributes(ctx context.Context, in *BatchRemoveCatalogAttributesRequest, opts ...grpc.CallOption) (*BatchRemoveCatalogAttributesResponse, error)
	// Replaces the specified
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] in the
	// [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig] by updating
	// the catalog attribute with the same
	// [CatalogAttribute.key][google.cloud.retail.v2beta.CatalogAttribute.key].
	//
	// If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to
	// replace does not exist, a NOT_FOUND error is returned.
	ReplaceCatalogAttribute(ctx context.Context, in *ReplaceCatalogAttributeRequest, opts ...grpc.CallOption) (*AttributesConfig, error)
}

CatalogServiceClient is the client API for CatalogService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewCatalogServiceClient

func NewCatalogServiceClient(cc grpc.ClientConnInterface) CatalogServiceClient

CatalogServiceServer

type CatalogServiceServer interface {
	// Lists all the [Catalog][google.cloud.retail.v2beta.Catalog]s associated
	// with the project.
	ListCatalogs(context.Context, *ListCatalogsRequest) (*ListCatalogsResponse, error)
	// Updates the [Catalog][google.cloud.retail.v2beta.Catalog]s.
	UpdateCatalog(context.Context, *UpdateCatalogRequest) (*Catalog, error)
	// Set a specified branch id as default branch. API methods such as
	// [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search],
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct],
	// [ProductService.ListProducts][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.SearchRequest.branch] to
	// `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent
	// to setting
	// [SearchRequest.branch][google.cloud.retail.v2beta.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][google.cloud.retail.v2beta.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}.
	SetDefaultBranch(context.Context, *SetDefaultBranchRequest) (*emptypb.Empty, error)
	// Get which branch is currently default branch set by
	// [CatalogService.SetDefaultBranch][google.cloud.retail.v2beta.CatalogService.SetDefaultBranch]
	// method under a specified parent catalog.
	GetDefaultBranch(context.Context, *GetDefaultBranchRequest) (*GetDefaultBranchResponse, error)
	// Gets a [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig].
	GetCompletionConfig(context.Context, *GetCompletionConfigRequest) (*CompletionConfig, error)
	// Updates the
	// [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig]s.
	UpdateCompletionConfig(context.Context, *UpdateCompletionConfigRequest) (*CompletionConfig, error)
	// Gets an [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
	GetAttributesConfig(context.Context, *GetAttributesConfigRequest) (*AttributesConfig, error)
	// Updates the
	// [AttributesConfig][google.cloud.retail.v2beta.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.
	UpdateAttributesConfig(context.Context, *UpdateAttributesConfigRequest) (*AttributesConfig, error)
	// Adds the specified
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to the
	// [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
	//
	// If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to
	// add already exists, an ALREADY_EXISTS error is returned.
	AddCatalogAttribute(context.Context, *AddCatalogAttributeRequest) (*AttributesConfig, error)
	// Removes the specified
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] from the
	// [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
	//
	// If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to
	// remove does not exist, a NOT_FOUND error is returned.
	RemoveCatalogAttribute(context.Context, *RemoveCatalogAttributeRequest) (*AttributesConfig, error)
	// Removes all specified
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s from the
	// [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
	BatchRemoveCatalogAttributes(context.Context, *BatchRemoveCatalogAttributesRequest) (*BatchRemoveCatalogAttributesResponse, error)
	// Replaces the specified
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] in the
	// [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig] by updating
	// the catalog attribute with the same
	// [CatalogAttribute.key][google.cloud.retail.v2beta.CatalogAttribute.key].
	//
	// If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to
	// replace does not exist, a NOT_FOUND error is returned.
	ReplaceCatalogAttribute(context.Context, *ReplaceCatalogAttributeRequest) (*AttributesConfig, error)
}

CatalogServiceServer is the server API for CatalogService service.

CollectUserEventRequest

type CollectUserEventRequest struct {

	// The rule that can convert the raw_json to a user event. It is needed
	// only when the raw_json is set.
	//
	// Types that are assignable to ConversionRule:
	//
	//	*CollectUserEventRequest_PrebuiltRule
	ConversionRule isCollectUserEventRequest_ConversionRule `protobuf_oneof:"conversion_rule"`
	// Required. The parent catalog name, such as
	// `projects/1234/locations/global/catalogs/default_catalog`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. URL encoded UserEvent proto with a length limit of 2,000,000
	// characters.
	UserEvent string `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
	// The URL including cgi-parameters but excluding the hash fragment with a
	// length limit of 5,000 characters. This is often more useful than the
	// referer URL, because many browsers only send the domain for 3rd party
	// requests.
	Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
	// The event timestamp in milliseconds. This prevents browser caching of
	// otherwise identical get requests. The name is abbreviated to reduce the
	// payload bytes.
	Ets int64 `protobuf:"varint,4,opt,name=ets,proto3" json:"ets,omitempty"`
	// An arbitrary serialized JSON string that contains necessary information
	// that can comprise a user event. When this field is specified, the
	// user_event field will be ignored. Note: line-delimited JSON is not
	// supported, a single JSON only.
	RawJson string `protobuf:"bytes,5,opt,name=raw_json,json=rawJson,proto3" json:"raw_json,omitempty"`
	// contains filtered or unexported fields
}

Request message for CollectUserEvent method.

func (*CollectUserEventRequest) Descriptor

func (*CollectUserEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use CollectUserEventRequest.ProtoReflect.Descriptor instead.

func (*CollectUserEventRequest) GetConversionRule

func (m *CollectUserEventRequest) GetConversionRule() isCollectUserEventRequest_ConversionRule

func (*CollectUserEventRequest) GetEts

func (x *CollectUserEventRequest) GetEts() int64

func (*CollectUserEventRequest) GetParent

func (x *CollectUserEventRequest) GetParent() string

func (*CollectUserEventRequest) GetPrebuiltRule

func (x *CollectUserEventRequest) GetPrebuiltRule() string

func (*CollectUserEventRequest) GetRawJson

func (x *CollectUserEventRequest) GetRawJson() string

func (*CollectUserEventRequest) GetUri

func (x *CollectUserEventRequest) GetUri() string

func (*CollectUserEventRequest) GetUserEvent

func (x *CollectUserEventRequest) GetUserEvent() string

func (*CollectUserEventRequest) ProtoMessage

func (*CollectUserEventRequest) ProtoMessage()

func (*CollectUserEventRequest) ProtoReflect

func (x *CollectUserEventRequest) ProtoReflect() protoreflect.Message

func (*CollectUserEventRequest) Reset

func (x *CollectUserEventRequest) Reset()

func (*CollectUserEventRequest) String

func (x *CollectUserEventRequest) String() string

CollectUserEventRequest_PrebuiltRule

type CollectUserEventRequest_PrebuiltRule struct {
	// The prebuilt rule name that can convert a specific type of raw_json.
	// For example: "ga4_bq" rule for the GA4 user event schema.
	PrebuiltRule string `protobuf:"bytes,6,opt,name=prebuilt_rule,json=prebuiltRule,proto3,oneof"`
}

ColorInfo

type ColorInfo struct {

	// The standard color families. Strongly recommended to use the following
	// standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple",
	// "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and
	// "Mixed". Normally it is expected to have only 1 color family. May consider
	// using single "Mixed" instead of multiple values.
	//
	// A maximum of 5 values are allowed. Each value must be a UTF-8 encoded
	// string with a length limit of 128 characters. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	//
	// Google Merchant Center property
	// [color](https://support.google.com/merchants/answer/6324487). Schema.org
	// property [Product.color](https://schema.org/color).
	ColorFamilies []string `protobuf:"bytes,1,rep,name=color_families,json=colorFamilies,proto3" json:"color_families,omitempty"`
	// The color display names, which may be different from standard color family
	// names, such as the color aliases used in the website frontend. Normally
	// it is expected to have only 1 color. May consider using single "Mixed"
	// instead of multiple values.
	//
	// A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded
	// string with a length limit of 128 characters. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	//
	// Google Merchant Center property
	// [color](https://support.google.com/merchants/answer/6324487). Schema.org
	// property [Product.color](https://schema.org/color).
	Colors []string `protobuf:"bytes,2,rep,name=colors,proto3" json:"colors,omitempty"`
	// contains filtered or unexported fields
}

The color information of a [Product][google.cloud.retail.v2beta.Product].

func (*ColorInfo) Descriptor

func (*ColorInfo) Descriptor() ([]byte, []int)

Deprecated: Use ColorInfo.ProtoReflect.Descriptor instead.

func (*ColorInfo) GetColorFamilies

func (x *ColorInfo) GetColorFamilies() []string

func (*ColorInfo) GetColors

func (x *ColorInfo) GetColors() []string

func (*ColorInfo) ProtoMessage

func (*ColorInfo) ProtoMessage()

func (*ColorInfo) ProtoReflect

func (x *ColorInfo) ProtoReflect() protoreflect.Message

func (*ColorInfo) Reset

func (x *ColorInfo) Reset()

func (*ColorInfo) String

func (x *ColorInfo) String() string

CompleteQueryRequest

type CompleteQueryRequest struct {

	// Required. Catalog for which the completion is performed.
	//
	// Full resource name of catalog, such as
	// `projects/*/locations/global/catalogs/default_catalog`.
	Catalog string `protobuf:"bytes,1,opt,name=catalog,proto3" json:"catalog,omitempty"`
	// Required. The query used to generate suggestions.
	//
	// The maximum number of allowed characters is 255.
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Required field. A unique identifier for tracking visitors. For example,
	// this could be implemented with an HTTP cookie, which should be able to
	// uniquely identify a visitor on a single device. This unique identifier
	// should not change if the visitor logs in or out of the website.
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	VisitorId string `protobuf:"bytes,7,opt,name=visitor_id,json=visitorId,proto3" json:"visitor_id,omitempty"`
	// Note that this field applies for `user-data` dataset only. For requests
	// with `cloud-retail` dataset, setting this field has no effect.
	//
	// The language filters applied to the output suggestions. If set, it should
	// contain the language of the query. If not set, suggestions are returned
	// without considering language restrictions. This is the BCP-47 language
	// code, such as "en-US" or "sr-Latn". For more information, see [Tags for
	// Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
	// number of language codes is 3.
	LanguageCodes []string `protobuf:"bytes,3,rep,name=language_codes,json=languageCodes,proto3" json:"language_codes,omitempty"`
	// The device type context for completion suggestions. We recommend that you
	// leave this field empty.
	//
	// It can apply different suggestions on different device types, e.g.
	// `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
	// types.
	//
	// Supported formats:
	//
	// * `UNKNOWN_DEVICE_TYPE`
	//
	// * `DESKTOP`
	//
	// * `MOBILE`
	//
	// * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
	DeviceType string `protobuf:"bytes,4,opt,name=device_type,json=deviceType,proto3" json:"device_type,omitempty"`
	// Determines which dataset to use for fetching completion. "user-data" will
	// use the imported dataset through
	// [CompletionService.ImportCompletionData][google.cloud.retail.v2beta.CompletionService.ImportCompletionData].
	// "cloud-retail" will use the dataset generated by cloud retail based on user
	// events. If leave empty, it will use the "user-data".
	//
	// Current supported values:
	//
	// * user-data
	//
	//   - cloud-retail:
	//     This option requires enabling auto-learning function first. See
	//     [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
	Dataset string `protobuf:"bytes,6,opt,name=dataset,proto3" json:"dataset,omitempty"`
	// Completion max suggestions. If left unset or set to 0, then will fallback
	// to the configured value
	// [CompletionConfig.max_suggestions][google.cloud.retail.v2beta.CompletionConfig.max_suggestions].
	//
	// The maximum allowed max suggestions is 20. If it is set higher, it will be
	// capped by 20.
	MaxSuggestions int32 `protobuf:"varint,5,opt,name=max_suggestions,json=maxSuggestions,proto3" json:"max_suggestions,omitempty"`
	// The entity for customers that may run multiple different entities, domains,
	// sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
	// `google.com`, `youtube.com`, etc.
	// If this is set, it should be exactly matched with
	// [UserEvent.entity][google.cloud.retail.v2beta.UserEvent.entity] to get
	// per-entity autocomplete results.
	Entity string `protobuf:"bytes,10,opt,name=entity,proto3" json:"entity,omitempty"`
	// contains filtered or unexported fields
}

Autocomplete parameters.

func (*CompleteQueryRequest) Descriptor

func (*CompleteQueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use CompleteQueryRequest.ProtoReflect.Descriptor instead.

func (*CompleteQueryRequest) GetCatalog

func (x *CompleteQueryRequest) GetCatalog() string

func (*CompleteQueryRequest) GetDataset

func (x *CompleteQueryRequest) GetDataset() string

func (*CompleteQueryRequest) GetDeviceType

func (x *CompleteQueryRequest) GetDeviceType() string

func (*CompleteQueryRequest) GetEntity

func (x *CompleteQueryRequest) GetEntity() string

func (*CompleteQueryRequest) GetLanguageCodes

func (x *CompleteQueryRequest) GetLanguageCodes() []string

func (*CompleteQueryRequest) GetMaxSuggestions

func (x *CompleteQueryRequest) GetMaxSuggestions() int32

func (*CompleteQueryRequest) GetQuery

func (x *CompleteQueryRequest) GetQuery() string

func (*CompleteQueryRequest) GetVisitorId

func (x *CompleteQueryRequest) GetVisitorId() string

func (*CompleteQueryRequest) ProtoMessage

func (*CompleteQueryRequest) ProtoMessage()

func (*CompleteQueryRequest) ProtoReflect

func (x *CompleteQueryRequest) ProtoReflect() protoreflect.Message

func (*CompleteQueryRequest) Reset

func (x *CompleteQueryRequest) Reset()

func (*CompleteQueryRequest) String

func (x *CompleteQueryRequest) String() string

CompleteQueryResponse

type CompleteQueryResponse struct {

	// Results of the matching suggestions. The result list is ordered and the
	// first result is top suggestion.
	CompletionResults []*CompleteQueryResponse_CompletionResult `protobuf:"bytes,1,rep,name=completion_results,json=completionResults,proto3" json:"completion_results,omitempty"`
	// A unique complete token. This should be included in the
	// [UserEvent.completion_detail][google.cloud.retail.v2beta.UserEvent.completion_detail]
	// for search events resulting from this completion, which enables accurate
	// attribution of complete model performance.
	AttributionToken string `protobuf:"bytes,2,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
	// Matched recent searches of this user. The maximum number of recent searches
	// is 10. This field is a restricted feature. Contact Retail Search support
	// team if you are interested in enabling it.
	//
	// This feature is only available when
	// [CompleteQueryRequest.visitor_id][google.cloud.retail.v2beta.CompleteQueryRequest.visitor_id]
	// field is set and [UserEvent][google.cloud.retail.v2beta.UserEvent] is
	// imported. The recent searches satisfy the follow rules:
	//
	//   - They are ordered from latest to oldest.
	//
	//   - They are matched with
	//     [CompleteQueryRequest.query][google.cloud.retail.v2beta.CompleteQueryRequest.query]
	//     case insensitively.
	//
	//   - They are transformed to lower case.
	//
	//   - They are UTF-8 safe.
	//
	// Recent searches are deduplicated. More recent searches will be reserved
	// when duplication happens.
	RecentSearchResults []*CompleteQueryResponse_RecentSearchResult `protobuf:"bytes,3,rep,name=recent_search_results,json=recentSearchResults,proto3" json:"recent_search_results,omitempty"`
	// contains filtered or unexported fields
}

Response of the autocomplete query.

func (*CompleteQueryResponse) Descriptor

func (*CompleteQueryResponse) Descriptor() ([]byte, []int)

Deprecated: Use CompleteQueryResponse.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse) GetAttributionToken

func (x *CompleteQueryResponse) GetAttributionToken() string

func (*CompleteQueryResponse) GetCompletionResults

func (x *CompleteQueryResponse) GetCompletionResults() []*CompleteQueryResponse_CompletionResult

func (*CompleteQueryResponse) GetRecentSearchResults

func (x *CompleteQueryResponse) GetRecentSearchResults() []*CompleteQueryResponse_RecentSearchResult

func (*CompleteQueryResponse) ProtoMessage

func (*CompleteQueryResponse) ProtoMessage()

func (*CompleteQueryResponse) ProtoReflect

func (x *CompleteQueryResponse) ProtoReflect() protoreflect.Message

func (*CompleteQueryResponse) Reset

func (x *CompleteQueryResponse) Reset()

func (*CompleteQueryResponse) String

func (x *CompleteQueryResponse) String() string

CompleteQueryResponse_CompletionResult

type CompleteQueryResponse_CompletionResult struct {
	Suggestion string `protobuf:"bytes,1,opt,name=suggestion,proto3" json:"suggestion,omitempty"`

	Attributes map[string]*CustomAttribute "" /* 161 byte string literal not displayed */

}

Resource that represents completion results.

func (*CompleteQueryResponse_CompletionResult) Descriptor

func (*CompleteQueryResponse_CompletionResult) Descriptor() ([]byte, []int)

Deprecated: Use CompleteQueryResponse_CompletionResult.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse_CompletionResult) GetAttributes

func (x *CompleteQueryResponse_CompletionResult) GetAttributes() map[string]*CustomAttribute

func (*CompleteQueryResponse_CompletionResult) GetSuggestion

func (x *CompleteQueryResponse_CompletionResult) GetSuggestion() string

func (*CompleteQueryResponse_CompletionResult) ProtoMessage

func (*CompleteQueryResponse_CompletionResult) ProtoMessage()

func (*CompleteQueryResponse_CompletionResult) ProtoReflect

func (x *CompleteQueryResponse_CompletionResult) ProtoReflect() protoreflect.Message

func (*CompleteQueryResponse_CompletionResult) Reset

func (x *CompleteQueryResponse_CompletionResult) Reset()

func (*CompleteQueryResponse_CompletionResult) String

func (x *CompleteQueryResponse_CompletionResult) String() string

CompleteQueryResponse_RecentSearchResult

type CompleteQueryResponse_RecentSearchResult struct {

	// The recent search query.
	RecentSearch string `protobuf:"bytes,1,opt,name=recent_search,json=recentSearch,proto3" json:"recent_search,omitempty"`
	// contains filtered or unexported fields
}

Recent search of this user.

func (*CompleteQueryResponse_RecentSearchResult) Descriptor

func (*CompleteQueryResponse_RecentSearchResult) Descriptor() ([]byte, []int)

Deprecated: Use CompleteQueryResponse_RecentSearchResult.ProtoReflect.Descriptor instead.

func (*CompleteQueryResponse_RecentSearchResult) GetRecentSearch

func (x *CompleteQueryResponse_RecentSearchResult) GetRecentSearch() string

func (*CompleteQueryResponse_RecentSearchResult) ProtoMessage

func (*CompleteQueryResponse_RecentSearchResult) ProtoMessage()

func (*CompleteQueryResponse_RecentSearchResult) ProtoReflect

func (x *CompleteQueryResponse_RecentSearchResult) ProtoReflect() protoreflect.Message

func (*CompleteQueryResponse_RecentSearchResult) Reset

func (x *CompleteQueryResponse_RecentSearchResult) Reset()

func (*CompleteQueryResponse_RecentSearchResult) String

func (x *CompleteQueryResponse_RecentSearchResult) String() string

CompletionConfig

type CompletionConfig struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	MatchingOrder string `protobuf:"bytes,2,opt,name=matching_order,json=matchingOrder,proto3" json:"matching_order,omitempty"`

	MaxSuggestions int32 `protobuf:"varint,3,opt,name=max_suggestions,json=maxSuggestions,proto3" json:"max_suggestions,omitempty"`

	MinPrefixLength int32 `protobuf:"varint,4,opt,name=min_prefix_length,json=minPrefixLength,proto3" json:"min_prefix_length,omitempty"`

	AutoLearning bool `protobuf:"varint,11,opt,name=auto_learning,json=autoLearning,proto3" json:"auto_learning,omitempty"`

	SuggestionsInputConfig *CompletionDataInputConfig "" /* 129 byte string literal not displayed */

	LastSuggestionsImportOperation string "" /* 155 byte string literal not displayed */

	DenylistInputConfig *CompletionDataInputConfig `protobuf:"bytes,7,opt,name=denylist_input_config,json=denylistInputConfig,proto3" json:"denylist_input_config,omitempty"`

	LastDenylistImportOperation string "" /* 146 byte string literal not displayed */

	AllowlistInputConfig *CompletionDataInputConfig `protobuf:"bytes,9,opt,name=allowlist_input_config,json=allowlistInputConfig,proto3" json:"allowlist_input_config,omitempty"`

	LastAllowlistImportOperation string "" /* 150 byte string literal not displayed */

}

Catalog level autocomplete config for customers to customize autocomplete feature's settings.

func (*CompletionConfig) Descriptor

func (*CompletionConfig) Descriptor() ([]byte, []int)

Deprecated: Use CompletionConfig.ProtoReflect.Descriptor instead.

func (*CompletionConfig) GetAllowlistInputConfig

func (x *CompletionConfig) GetAllowlistInputConfig() *CompletionDataInputConfig

func (*CompletionConfig) GetAutoLearning

func (x *CompletionConfig) GetAutoLearning() bool

func (*CompletionConfig) GetDenylistInputConfig

func (x *CompletionConfig) GetDenylistInputConfig() *CompletionDataInputConfig

func (*CompletionConfig) GetLastAllowlistImportOperation

func (x *CompletionConfig) GetLastAllowlistImportOperation() string

func (*CompletionConfig) GetLastDenylistImportOperation

func (x *CompletionConfig) GetLastDenylistImportOperation() string

func (*CompletionConfig) GetLastSuggestionsImportOperation

func (x *CompletionConfig) GetLastSuggestionsImportOperation() string

func (*CompletionConfig) GetMatchingOrder

func (x *CompletionConfig) GetMatchingOrder() string

func (*CompletionConfig) GetMaxSuggestions

func (x *CompletionConfig) GetMaxSuggestions() int32

func (*CompletionConfig) GetMinPrefixLength

func (x *CompletionConfig) GetMinPrefixLength() int32

func (*CompletionConfig) GetName

func (x *CompletionConfig) GetName() string

func (*CompletionConfig) GetSuggestionsInputConfig

func (x *CompletionConfig) GetSuggestionsInputConfig() *CompletionDataInputConfig

func (*CompletionConfig) ProtoMessage

func (*CompletionConfig) ProtoMessage()

func (*CompletionConfig) ProtoReflect

func (x *CompletionConfig) ProtoReflect() protoreflect.Message

func (*CompletionConfig) Reset

func (x *CompletionConfig) Reset()

func (*CompletionConfig) String

func (x *CompletionConfig) String() string

CompletionDataInputConfig

type CompletionDataInputConfig struct {

	// The source of the input.
	//
	// Supported
	// [BigQuerySource.data_schema][google.cloud.retail.v2beta.BigQuerySource.data_schema]
	// values for suggestions imports:
	//
	// * `suggestions` (default): One JSON completion suggestion per line.
	// * `denylist`:  One JSON deny suggestion per line.
	// * `allowlist`:  One JSON allow suggestion per line.
	//
	// Types that are assignable to Source:
	//
	//	*CompletionDataInputConfig_BigQuerySource
	Source isCompletionDataInputConfig_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

The input config source for completion data.

func (*CompletionDataInputConfig) Descriptor

func (*CompletionDataInputConfig) Descriptor() ([]byte, []int)

Deprecated: Use CompletionDataInputConfig.ProtoReflect.Descriptor instead.

func (*CompletionDataInputConfig) GetBigQuerySource

func (x *CompletionDataInputConfig) GetBigQuerySource() *BigQuerySource

func (*CompletionDataInputConfig) GetSource

func (m *CompletionDataInputConfig) GetSource() isCompletionDataInputConfig_Source

func (*CompletionDataInputConfig) ProtoMessage

func (*CompletionDataInputConfig) ProtoMessage()

func (*CompletionDataInputConfig) ProtoReflect

func (x *CompletionDataInputConfig) ProtoReflect() protoreflect.Message

func (*CompletionDataInputConfig) Reset

func (x *CompletionDataInputConfig) Reset()

func (*CompletionDataInputConfig) String

func (x *CompletionDataInputConfig) String() string

CompletionDataInputConfig_BigQuerySource

type CompletionDataInputConfig_BigQuerySource struct {
	// Required. BigQuery input source.
	//
	// Add the IAM permission "BigQuery Data Viewer" for
	// [e-mail] before
	// using this feature otherwise an error is thrown.
	BigQuerySource *BigQuerySource `protobuf:"bytes,1,opt,name=big_query_source,json=bigQuerySource,proto3,oneof"`
}

CompletionDetail

type CompletionDetail struct {
	CompletionAttributionToken string "" /* 141 byte string literal not displayed */

	SelectedSuggestion string `protobuf:"bytes,2,opt,name=selected_suggestion,json=selectedSuggestion,proto3" json:"selected_suggestion,omitempty"`

	SelectedPosition int32 `protobuf:"varint,3,opt,name=selected_position,json=selectedPosition,proto3" json:"selected_position,omitempty"`

}

Detailed completion information including completion attribution token and clicked completion info.

func (*CompletionDetail) Descriptor

func (*CompletionDetail) Descriptor() ([]byte, []int)

Deprecated: Use CompletionDetail.ProtoReflect.Descriptor instead.

func (*CompletionDetail) GetCompletionAttributionToken

func (x *CompletionDetail) GetCompletionAttributionToken() string

func (*CompletionDetail) GetSelectedPosition

func (x *CompletionDetail) GetSelectedPosition() int32

func (*CompletionDetail) GetSelectedSuggestion

func (x *CompletionDetail) GetSelectedSuggestion() string

func (*CompletionDetail) ProtoMessage

func (*CompletionDetail) ProtoMessage()

func (*CompletionDetail) ProtoReflect

func (x *CompletionDetail) ProtoReflect() protoreflect.Message

func (*CompletionDetail) Reset

func (x *CompletionDetail) Reset()

func (*CompletionDetail) String

func (x *CompletionDetail) String() string

CompletionServiceClient

type CompletionServiceClient interface {
	// 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.
	CompleteQuery(ctx context.Context, in *CompleteQueryRequest, opts ...grpc.CallOption) (*CompleteQueryResponse, error)
	// Bulk import of processed completion dataset.
	//
	// Request processing is asynchronous. Partial updating is not supported.
	//
	// The operation is successfully finished only after the imported suggestions
	// are indexed successfully and ready for serving. The process takes hours.
	//
	// This feature is only available for users who have Retail Search enabled.
	// Enable Retail Search on Cloud Console before using this feature.
	ImportCompletionData(ctx context.Context, in *ImportCompletionDataRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

CompletionServiceClient is the client API for CompletionService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewCompletionServiceClient

func NewCompletionServiceClient(cc grpc.ClientConnInterface) CompletionServiceClient

CompletionServiceServer

type CompletionServiceServer interface {
	// 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.
	CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)
	// Bulk import of processed completion dataset.
	//
	// Request processing is asynchronous. Partial updating is not supported.
	//
	// The operation is successfully finished only after the imported suggestions
	// are indexed successfully and ready for serving. The process takes hours.
	//
	// This feature is only available for users who have Retail Search enabled.
	// Enable Retail Search on Cloud Console before using this feature.
	ImportCompletionData(context.Context, *ImportCompletionDataRequest) (*longrunningpb.Operation, error)
}

CompletionServiceServer is the server API for CompletionService service.

Condition

type Condition struct {

	// A list (up to 10 entries) of terms to match the query on. If not
	// specified, match all queries.
	// If many query terms are specified, the condition
	// is matched if any of the terms is a match (i.e. using the OR operator).
	QueryTerms []*Condition_QueryTerm `protobuf:"bytes,1,rep,name=query_terms,json=queryTerms,proto3" json:"query_terms,omitempty"`
	// Range of time(s) specifying when Condition is active.
	// Condition true if any time range matches.
	ActiveTimeRange []*Condition_TimeRange `protobuf:"bytes,3,rep,name=active_time_range,json=activeTimeRange,proto3" json:"active_time_range,omitempty"`
	// contains filtered or unexported fields
}

Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.

func (*Condition) Descriptor

func (*Condition) Descriptor() ([]byte, []int)

Deprecated: Use Condition.ProtoReflect.Descriptor instead.

func (*Condition) GetActiveTimeRange

func (x *Condition) GetActiveTimeRange() []*Condition_TimeRange

func (*Condition) GetQueryTerms

func (x *Condition) GetQueryTerms() []*Condition_QueryTerm

func (*Condition) ProtoMessage

func (*Condition) ProtoMessage()

func (*Condition) ProtoReflect

func (x *Condition) ProtoReflect() protoreflect.Message

func (*Condition) Reset

func (x *Condition) Reset()

func (*Condition) String

func (x *Condition) String() string

Condition_QueryTerm

type Condition_QueryTerm struct {

	// The value of the term to match on.
	// Value cannot be empty.
	// Value can have at most 3 terms if specified as a partial match. Each
	// space separated string is considered as one term.
	// For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms
	// and not allowed for a partial match.
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// Whether this is supposed to be a full or partial match.
	FullMatch bool `protobuf:"varint,2,opt,name=full_match,json=fullMatch,proto3" json:"full_match,omitempty"`
	// contains filtered or unexported fields
}

Query terms that we want to match on.

func (*Condition_QueryTerm) Descriptor

func (*Condition_QueryTerm) Descriptor() ([]byte, []int)

Deprecated: Use Condition_QueryTerm.ProtoReflect.Descriptor instead.

func (*Condition_QueryTerm) GetFullMatch

func (x *Condition_QueryTerm) GetFullMatch() bool

func (*Condition_QueryTerm) GetValue

func (x *Condition_QueryTerm) GetValue() string

func (*Condition_QueryTerm) ProtoMessage

func (*Condition_QueryTerm) ProtoMessage()

func (*Condition_QueryTerm) ProtoReflect

func (x *Condition_QueryTerm) ProtoReflect() protoreflect.Message

func (*Condition_QueryTerm) Reset

func (x *Condition_QueryTerm) Reset()

func (*Condition_QueryTerm) String

func (x *Condition_QueryTerm) String() string

Condition_TimeRange

type Condition_TimeRange struct {

	// Start of time range. Range is inclusive.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// End of time range. Range is inclusive.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Used for time-dependent conditions. Example: Want to have rule applied for week long sale.

func (*Condition_TimeRange) Descriptor

func (*Condition_TimeRange) Descriptor() ([]byte, []int)

Deprecated: Use Condition_TimeRange.ProtoReflect.Descriptor instead.

func (*Condition_TimeRange) GetEndTime

func (x *Condition_TimeRange) GetEndTime() *timestamppb.Timestamp

func (*Condition_TimeRange) GetStartTime

func (x *Condition_TimeRange) GetStartTime() *timestamppb.Timestamp

func (*Condition_TimeRange) ProtoMessage

func (*Condition_TimeRange) ProtoMessage()

func (*Condition_TimeRange) ProtoReflect

func (x *Condition_TimeRange) ProtoReflect() protoreflect.Message

func (*Condition_TimeRange) Reset

func (x *Condition_TimeRange) Reset()

func (*Condition_TimeRange) String

func (x *Condition_TimeRange) String() string

Control

type Control struct {
	Control isControl_Control `protobuf_oneof:"control"`

	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`

	AssociatedServingConfigIds []string "" /* 143 byte string literal not displayed */

	SolutionTypes []SolutionType "" /* 153 byte string literal not displayed */

	SearchSolutionUseCase []SearchSolutionUseCase "" /* 190 byte string literal not displayed */

}

Configures dynamic metadata that can be linked to a [ServingConfig][google.cloud.retail.v2beta.ServingConfig] and affect search or recommendation results at serving time.

func (*Control) Descriptor

func (*Control) Descriptor() ([]byte, []int)

Deprecated: Use Control.ProtoReflect.Descriptor instead.

func (*Control) GetAssociatedServingConfigIds

func (x *Control) GetAssociatedServingConfigIds() []string

func (*Control) GetControl

func (m *Control) GetControl() isControl_Control

func (*Control) GetDisplayName

func (x *Control) GetDisplayName() string

func (*Control) GetFacetSpec

func (x *Control) GetFacetSpec() *SearchRequest_FacetSpec

Deprecated: Marked as deprecated in google/cloud/retail/v2beta/control.proto.

func (*Control) GetName

func (x *Control) GetName() string

func (*Control) GetRule

func (x *Control) GetRule() *Rule

func (*Control) GetSearchSolutionUseCase

func (x *Control) GetSearchSolutionUseCase() []SearchSolutionUseCase

func (*Control) GetSolutionTypes

func (x *Control) GetSolutionTypes() []SolutionType

func (*Control) ProtoMessage

func (*Control) ProtoMessage()

func (*Control) ProtoReflect

func (x *Control) ProtoReflect() protoreflect.Message

func (*Control) Reset

func (x *Control) Reset()

func (*Control) String

func (x *Control) String() string

ControlServiceClient

type ControlServiceClient interface {
	// Creates a Control.
	//
	// If the [Control][google.cloud.retail.v2beta.Control] to create already
	// exists, an ALREADY_EXISTS error is returned.
	CreateControl(ctx context.Context, in *CreateControlRequest, opts ...grpc.CallOption) (*Control, error)
	// Deletes a Control.
	//
	// If the [Control][google.cloud.retail.v2beta.Control] to delete does not
	// exist, a NOT_FOUND error is returned.
	DeleteControl(ctx context.Context, in *DeleteControlRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Updates a Control.
	//
	// [Control][google.cloud.retail.v2beta.Control] cannot be set to a different
	// oneof field, if so an INVALID_ARGUMENT is returned. If the
	// [Control][google.cloud.retail.v2beta.Control] to update does not exist, a
	// NOT_FOUND error is returned.
	UpdateControl(ctx context.Context, in *UpdateControlRequest, opts ...grpc.CallOption) (*Control, error)
	// Gets a Control.
	GetControl(ctx context.Context, in *GetControlRequest, opts ...grpc.CallOption) (*Control, error)
	// Lists all Controls by their parent
	// [Catalog][google.cloud.retail.v2beta.Catalog].
	ListControls(ctx context.Context, in *ListControlsRequest, opts ...grpc.CallOption) (*ListControlsResponse, error)
}

ControlServiceClient is the client API for ControlService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewControlServiceClient

func NewControlServiceClient(cc grpc.ClientConnInterface) ControlServiceClient

ControlServiceServer

type ControlServiceServer interface {
	// Creates a Control.
	//
	// If the [Control][google.cloud.retail.v2beta.Control] to create already
	// exists, an ALREADY_EXISTS error is returned.
	CreateControl(context.Context, *CreateControlRequest) (*Control, error)
	// Deletes a Control.
	//
	// If the [Control][google.cloud.retail.v2beta.Control] to delete does not
	// exist, a NOT_FOUND error is returned.
	DeleteControl(context.Context, *DeleteControlRequest) (*emptypb.Empty, error)
	// Updates a Control.
	//
	// [Control][google.cloud.retail.v2beta.Control] cannot be set to a different
	// oneof field, if so an INVALID_ARGUMENT is returned. If the
	// [Control][google.cloud.retail.v2beta.Control] to update does not exist, a
	// NOT_FOUND error is returned.
	UpdateControl(context.Context, *UpdateControlRequest) (*Control, error)
	// Gets a Control.
	GetControl(context.Context, *GetControlRequest) (*Control, error)
	// Lists all Controls by their parent
	// [Catalog][google.cloud.retail.v2beta.Catalog].
	ListControls(context.Context, *ListControlsRequest) (*ListControlsResponse, error)
}

ControlServiceServer is the server API for ControlService service.

Control_FacetSpec

type Control_FacetSpec struct {
	// A facet specification to perform faceted search.
	//
	// Note that this field is deprecated and will throw NOT_IMPLEMENTED if
	// used for creating a control.
	//
	// Deprecated: Marked as deprecated in google/cloud/retail/v2beta/control.proto.
	FacetSpec *SearchRequest_FacetSpec `protobuf:"bytes,3,opt,name=facet_spec,json=facetSpec,proto3,oneof"`
}

Control_Rule

type Control_Rule struct {
	// A rule control - a condition-action pair.
	// Enacts a set action when the condition is triggered.
	// For example: Boost "gShoe" when query full matches "Running Shoes".
	Rule *Rule `protobuf:"bytes,4,opt,name=rule,proto3,oneof"`
}

CreateControlRequest

type CreateControlRequest struct {

	// Required. Full resource name of parent catalog. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Control to create.
	Control *Control `protobuf:"bytes,2,opt,name=control,proto3" json:"control,omitempty"`
	// Required. The ID to use for the Control, which will become the final
	// component of the Control's resource name.
	//
	// This value should be 4-63 characters, and valid characters
	// are /[a-z][0-9]-_/.
	ControlId string `protobuf:"bytes,3,opt,name=control_id,json=controlId,proto3" json:"control_id,omitempty"`
	// contains filtered or unexported fields
}

Request for CreateControl method.

func (*CreateControlRequest) Descriptor

func (*CreateControlRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateControlRequest.ProtoReflect.Descriptor instead.

func (*CreateControlRequest) GetControl

func (x *CreateControlRequest) GetControl() *Control

func (*CreateControlRequest) GetControlId

func (x *CreateControlRequest) GetControlId() string

func (*CreateControlRequest) GetParent

func (x *CreateControlRequest) GetParent() string

func (*CreateControlRequest) ProtoMessage

func (*CreateControlRequest) ProtoMessage()

func (*CreateControlRequest) ProtoReflect

func (x *CreateControlRequest) ProtoReflect() protoreflect.Message

func (*CreateControlRequest) Reset

func (x *CreateControlRequest) Reset()

func (*CreateControlRequest) String

func (x *CreateControlRequest) String() string

CreateModelMetadata

type CreateModelMetadata struct {

	// The resource name of the model that this create applies to.
	// Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// contains filtered or unexported fields
}

Metadata associated with a create operation.

func (*CreateModelMetadata) Descriptor

func (*CreateModelMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateModelMetadata.ProtoReflect.Descriptor instead.

func (*CreateModelMetadata) GetModel

func (x *CreateModelMetadata) GetModel() string

func (*CreateModelMetadata) ProtoMessage

func (*CreateModelMetadata) ProtoMessage()

func (*CreateModelMetadata) ProtoReflect

func (x *CreateModelMetadata) ProtoReflect() protoreflect.Message

func (*CreateModelMetadata) Reset

func (x *CreateModelMetadata) Reset()

func (*CreateModelMetadata) String

func (x *CreateModelMetadata) String() string

CreateModelRequest

type CreateModelRequest struct {

	// Required. The parent resource under which to create the model. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The payload of the [Model][google.cloud.retail.v2beta.Model]  to
	// create.
	Model *Model `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
	// Optional. Whether to run a dry run to validate the request (without
	// actually creating the model).
	DryRun bool `protobuf:"varint,3,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
	// contains filtered or unexported fields
}

Request for creating a model.

func (*CreateModelRequest) Descriptor

func (*CreateModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateModelRequest.ProtoReflect.Descriptor instead.

func (*CreateModelRequest) GetDryRun

func (x *CreateModelRequest) GetDryRun() bool

func (*CreateModelRequest) GetModel

func (x *CreateModelRequest) GetModel() *Model

func (*CreateModelRequest) GetParent

func (x *CreateModelRequest) GetParent() string

func (*CreateModelRequest) ProtoMessage

func (*CreateModelRequest) ProtoMessage()

func (*CreateModelRequest) ProtoReflect

func (x *CreateModelRequest) ProtoReflect() protoreflect.Message

func (*CreateModelRequest) Reset

func (x *CreateModelRequest) Reset()

func (*CreateModelRequest) String

func (x *CreateModelRequest) String() string

CreateProductRequest

type CreateProductRequest struct {

	// Required. The parent catalog resource name, such as
	// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Product][google.cloud.retail.v2beta.Product] to create.
	Product *Product `protobuf:"bytes,2,opt,name=product,proto3" json:"product,omitempty"`
	// Required. The ID to use for the
	// [Product][google.cloud.retail.v2beta.Product], which will become the final
	// component of the [Product.name][google.cloud.retail.v2beta.Product.name].
	//
	// If the caller does not have permission to create the
	// [Product][google.cloud.retail.v2beta.Product], regardless of whether or not
	// it exists, a PERMISSION_DENIED error is returned.
	//
	// This field must be unique among all
	// [Product][google.cloud.retail.v2beta.Product]s with the same
	// [parent][google.cloud.retail.v2beta.CreateProductRequest.parent].
	// Otherwise, an ALREADY_EXISTS error is returned.
	//
	// This field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	ProductId string `protobuf:"bytes,3,opt,name=product_id,json=productId,proto3" json:"product_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct] method.

func (*CreateProductRequest) Descriptor

func (*CreateProductRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateProductRequest.ProtoReflect.Descriptor instead.

func (*CreateProductRequest) GetParent

func (x *CreateProductRequest) GetParent() string

func (*CreateProductRequest) GetProduct

func (x *CreateProductRequest) GetProduct() *Product

func (*CreateProductRequest) GetProductId

func (x *CreateProductRequest) GetProductId() string

func (*CreateProductRequest) ProtoMessage

func (*CreateProductRequest) ProtoMessage()

func (*CreateProductRequest) ProtoReflect

func (x *CreateProductRequest) ProtoReflect() protoreflect.Message

func (*CreateProductRequest) Reset

func (x *CreateProductRequest) Reset()

func (*CreateProductRequest) String

func (x *CreateProductRequest) String() string

CreateServingConfigRequest

type CreateServingConfigRequest struct {

	// Required. Full resource name of parent. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The ServingConfig to create.
	ServingConfig *ServingConfig `protobuf:"bytes,2,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// Required. The ID to use for the ServingConfig, which will become the final
	// component of the ServingConfig's resource name.
	//
	// This value should be 4-63 characters, and valid characters
	// are /[a-z][0-9]-_/.
	ServingConfigId string `protobuf:"bytes,3,opt,name=serving_config_id,json=servingConfigId,proto3" json:"serving_config_id,omitempty"`
	// contains filtered or unexported fields
}

Request for CreateServingConfig method.

func (*CreateServingConfigRequest) Descriptor

func (*CreateServingConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateServingConfigRequest.ProtoReflect.Descriptor instead.

func (*CreateServingConfigRequest) GetParent

func (x *CreateServingConfigRequest) GetParent() string

func (*CreateServingConfigRequest) GetServingConfig

func (x *CreateServingConfigRequest) GetServingConfig() *ServingConfig

func (*CreateServingConfigRequest) GetServingConfigId

func (x *CreateServingConfigRequest) GetServingConfigId() string

func (*CreateServingConfigRequest) ProtoMessage

func (*CreateServingConfigRequest) ProtoMessage()

func (*CreateServingConfigRequest) ProtoReflect

func (x *CreateServingConfigRequest) ProtoReflect() protoreflect.Message

func (*CreateServingConfigRequest) Reset

func (x *CreateServingConfigRequest) Reset()

func (*CreateServingConfigRequest) String

func (x *CreateServingConfigRequest) String() string

CustomAttribute

type CustomAttribute struct {

	// The textual values of this custom attribute. For example, `["yellow",
	// "green"]` when the key is "color".
	//
	// Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
	// returned.
	//
	// Exactly one of [text][google.cloud.retail.v2beta.CustomAttribute.text] or
	// [numbers][google.cloud.retail.v2beta.CustomAttribute.numbers] should be
	// set. Otherwise, an INVALID_ARGUMENT error is returned.
	Text []string `protobuf:"bytes,1,rep,name=text,proto3" json:"text,omitempty"`
	// The numerical values of this custom attribute. For example, `[2.3, 15.4]`
	// when the key is "lengths_cm".
	//
	// Exactly one of [text][google.cloud.retail.v2beta.CustomAttribute.text] or
	// [numbers][google.cloud.retail.v2beta.CustomAttribute.numbers] should be
	// set. Otherwise, an INVALID_ARGUMENT error is returned.
	Numbers []float64 `protobuf:"fixed64,2,rep,packed,name=numbers,proto3" json:"numbers,omitempty"`
	// This field is normally ignored unless
	// [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
	// of the [Catalog][google.cloud.retail.v2beta.Catalog] is set to the
	// deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
	// product-level attribute configuration, see [Configuration
	// modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
	// If true, custom attribute values are searchable by text queries in
	// [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].
	//
	// This field is ignored in a
	// [UserEvent][google.cloud.retail.v2beta.UserEvent].
	//
	// Only set if type [text][google.cloud.retail.v2beta.CustomAttribute.text] is
	// set. Otherwise, a INVALID_ARGUMENT error is returned.
	//
	// Deprecated: Marked as deprecated in google/cloud/retail/v2beta/common.proto.
	Searchable *bool `protobuf:"varint,3,opt,name=searchable,proto3,oneof" json:"searchable,omitempty"`
	// This field is normally ignored unless
	// [AttributesConfig.attribute_config_level][google.cloud.retail.v2beta.AttributesConfig.attribute_config_level]
	// of the [Catalog][google.cloud.retail.v2beta.Catalog] is set to the
	// deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
	// product-level attribute configuration, see [Configuration
	// modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
	// If true, custom attribute values are indexed, so that they can be filtered,
	// faceted or boosted in
	// [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].
	//
	// This field is ignored in a
	// [UserEvent][google.cloud.retail.v2beta.UserEvent].
	//
	// See
	// [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter],
	// [SearchRequest.facet_specs][google.cloud.retail.v2beta.SearchRequest.facet_specs]
	// and
	// [SearchRequest.boost_spec][google.cloud.retail.v2beta.SearchRequest.boost_spec]
	// for more details.
	//
	// Deprecated: Marked as deprecated in google/cloud/retail/v2beta/common.proto.
	Indexable *bool `protobuf:"varint,4,opt,name=indexable,proto3,oneof" json:"indexable,omitempty"`
	// contains filtered or unexported fields
}

A custom attribute that is not explicitly modeled in [Product][google.cloud.retail.v2beta.Product].

func (*CustomAttribute) Descriptor

func (*CustomAttribute) Descriptor() ([]byte, []int)

Deprecated: Use CustomAttribute.ProtoReflect.Descriptor instead.

func (*CustomAttribute) GetIndexable

func (x *CustomAttribute) GetIndexable() bool

Deprecated: Marked as deprecated in google/cloud/retail/v2beta/common.proto.

func (*CustomAttribute) GetNumbers

func (x *CustomAttribute) GetNumbers() []float64

func (*CustomAttribute) GetSearchable

func (x *CustomAttribute) GetSearchable() bool

Deprecated: Marked as deprecated in google/cloud/retail/v2beta/common.proto.

func (*CustomAttribute) GetText

func (x *CustomAttribute) GetText() []string

func (*CustomAttribute) ProtoMessage

func (*CustomAttribute) ProtoMessage()

func (*CustomAttribute) ProtoReflect

func (x *CustomAttribute) ProtoReflect() protoreflect.Message

func (*CustomAttribute) Reset

func (x *CustomAttribute) Reset()

func (*CustomAttribute) String

func (x *CustomAttribute) String() string

DeleteControlRequest

type DeleteControlRequest struct {

	// Required. The resource name of the Control to delete. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for DeleteControl method.

func (*DeleteControlRequest) Descriptor

func (*DeleteControlRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteControlRequest.ProtoReflect.Descriptor instead.

func (*DeleteControlRequest) GetName

func (x *DeleteControlRequest) GetName() string

func (*DeleteControlRequest) ProtoMessage

func (*DeleteControlRequest) ProtoMessage()

func (*DeleteControlRequest) ProtoReflect

func (x *DeleteControlRequest) ProtoReflect() protoreflect.Message

func (*DeleteControlRequest) Reset

func (x *DeleteControlRequest) Reset()

func (*DeleteControlRequest) String

func (x *DeleteControlRequest) String() string

DeleteModelRequest

type DeleteModelRequest struct {

	// Required. The resource name of the
	// [Model][google.cloud.retail.v2beta.Model] to delete. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for deleting a model.

func (*DeleteModelRequest) Descriptor

func (*DeleteModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteModelRequest.ProtoReflect.Descriptor instead.

func (*DeleteModelRequest) GetName

func (x *DeleteModelRequest) GetName() string

func (*DeleteModelRequest) ProtoMessage

func (*DeleteModelRequest) ProtoMessage()

func (*DeleteModelRequest) ProtoReflect

func (x *DeleteModelRequest) ProtoReflect() protoreflect.Message

func (*DeleteModelRequest) Reset

func (x *DeleteModelRequest) Reset()

func (*DeleteModelRequest) String

func (x *DeleteModelRequest) String() string

DeleteProductRequest

type DeleteProductRequest struct {

	// Required. Full resource name of
	// [Product][google.cloud.retail.v2beta.Product], such as
	// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
	//
	// If the caller does not have permission to delete the
	// [Product][google.cloud.retail.v2beta.Product], regardless of whether or not
	// it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Product][google.cloud.retail.v2beta.Product] to delete does not
	// exist, a NOT_FOUND error is returned.
	//
	// The [Product][google.cloud.retail.v2beta.Product] to delete can neither be
	// a
	// [Product.Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]
	// [Product][google.cloud.retail.v2beta.Product] member nor a
	// [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2beta.Product] with more than one
	// [variants][google.cloud.retail.v2beta.Product.Type.VARIANT]. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	//
	// All inventory information for the named
	// [Product][google.cloud.retail.v2beta.Product] will be deleted.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProductService.DeleteProduct][google.cloud.retail.v2beta.ProductService.DeleteProduct] method.

func (*DeleteProductRequest) Descriptor

func (*DeleteProductRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteProductRequest.ProtoReflect.Descriptor instead.

func (*DeleteProductRequest) GetName

func (x *DeleteProductRequest) GetName() string

func (*DeleteProductRequest) ProtoMessage

func (*DeleteProductRequest) ProtoMessage()

func (*DeleteProductRequest) ProtoReflect

func (x *DeleteProductRequest) ProtoReflect() protoreflect.Message

func (*DeleteProductRequest) Reset

func (x *DeleteProductRequest) Reset()

func (*DeleteProductRequest) String

func (x *DeleteProductRequest) String() string

DeleteServingConfigRequest

type DeleteServingConfigRequest struct {

	// Required. The resource name of the ServingConfig to delete. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for DeleteServingConfig method.

func (*DeleteServingConfigRequest) Descriptor

func (*DeleteServingConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteServingConfigRequest.ProtoReflect.Descriptor instead.

func (*DeleteServingConfigRequest) GetName

func (x *DeleteServingConfigRequest) GetName() string

func (*DeleteServingConfigRequest) ProtoMessage

func (*DeleteServingConfigRequest) ProtoMessage()

func (*DeleteServingConfigRequest) ProtoReflect

func (x *DeleteServingConfigRequest) ProtoReflect() protoreflect.Message

func (*DeleteServingConfigRequest) Reset

func (x *DeleteServingConfigRequest) Reset()

func (*DeleteServingConfigRequest) String

func (x *DeleteServingConfigRequest) String() string

ExperimentInfo

type ExperimentInfo struct {

	// Information associated with the specific experiment entity being recorded.
	//
	// Types that are assignable to ExperimentMetadata:
	//
	//	*ExperimentInfo_ServingConfigExperiment_
	ExperimentMetadata isExperimentInfo_ExperimentMetadata `protobuf_oneof:"experiment_metadata"`
	// The fully qualified resource name of the experiment that provides the
	// serving config under test, should an active experiment exist. For example:
	// `projects/*/locations/global/catalogs/default_catalog/experiments/experiment_id`
	Experiment string `protobuf:"bytes,1,opt,name=experiment,proto3" json:"experiment,omitempty"`
	// contains filtered or unexported fields
}

Metadata for active A/B testing [Experiments][].

func (*ExperimentInfo) Descriptor

func (*ExperimentInfo) Descriptor() ([]byte, []int)

Deprecated: Use ExperimentInfo.ProtoReflect.Descriptor instead.

func (*ExperimentInfo) GetExperiment

func (x *ExperimentInfo) GetExperiment() string

func (*ExperimentInfo) GetExperimentMetadata

func (m *ExperimentInfo) GetExperimentMetadata() isExperimentInfo_ExperimentMetadata

func (*ExperimentInfo) GetServingConfigExperiment

func (x *ExperimentInfo) GetServingConfigExperiment() *ExperimentInfo_ServingConfigExperiment

func (*ExperimentInfo) ProtoMessage

func (*ExperimentInfo) ProtoMessage()

func (*ExperimentInfo) ProtoReflect

func (x *ExperimentInfo) ProtoReflect() protoreflect.Message

func (*ExperimentInfo) Reset

func (x *ExperimentInfo) Reset()

func (*ExperimentInfo) String

func (x *ExperimentInfo) String() string

ExperimentInfo_ServingConfigExperiment

type ExperimentInfo_ServingConfigExperiment struct {
	OriginalServingConfig string `protobuf:"bytes,1,opt,name=original_serving_config,json=originalServingConfig,proto3" json:"original_serving_config,omitempty"`

	ExperimentServingConfig string "" /* 132 byte string literal not displayed */

}

Metadata for active serving config A/B tests.

func (*ExperimentInfo_ServingConfigExperiment) Descriptor

func (*ExperimentInfo_ServingConfigExperiment) Descriptor() ([]byte, []int)

Deprecated: Use ExperimentInfo_ServingConfigExperiment.ProtoReflect.Descriptor instead.

func (*ExperimentInfo_ServingConfigExperiment) GetExperimentServingConfig

func (x *ExperimentInfo_ServingConfigExperiment) GetExperimentServingConfig() string

func (*ExperimentInfo_ServingConfigExperiment) GetOriginalServingConfig

func (x *ExperimentInfo_ServingConfigExperiment) GetOriginalServingConfig() string

func (*ExperimentInfo_ServingConfigExperiment) ProtoMessage

func (*ExperimentInfo_ServingConfigExperiment) ProtoMessage()

func (*ExperimentInfo_ServingConfigExperiment) ProtoReflect

func (x *ExperimentInfo_ServingConfigExperiment) ProtoReflect() protoreflect.Message

func (*ExperimentInfo_ServingConfigExperiment) Reset

func (x *ExperimentInfo_ServingConfigExperiment) Reset()

func (*ExperimentInfo_ServingConfigExperiment) String

func (x *ExperimentInfo_ServingConfigExperiment) String() string

ExperimentInfo_ServingConfigExperiment_

type ExperimentInfo_ServingConfigExperiment_ struct {
	// A/B test between existing Cloud Retail Search
	// [ServingConfig][google.cloud.retail.v2beta.ServingConfig]s.
	ServingConfigExperiment *ExperimentInfo_ServingConfigExperiment `protobuf:"bytes,2,opt,name=serving_config_experiment,json=servingConfigExperiment,proto3,oneof"`
}

ExportAnalyticsMetricsRequest

type ExportAnalyticsMetricsRequest struct {

	// Required. Full resource name of the parent catalog.
	// Expected format: `projects/*/locations/*/catalogs/*`
	Catalog string `protobuf:"bytes,1,opt,name=catalog,proto3" json:"catalog,omitempty"`
	// Required. The output location of the data.
	OutputConfig *OutputConfig `protobuf:"bytes,2,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
	// A filtering expression to specify restrictions on returned metrics.
	// The expression is a sequence of terms. Each term applies a restriction to
	// the returned metrics. Use this expression to restrict results to a
	// specific time range.
	//
	//	Currently we expect only one types of fields:
	//
	//	 * `timestamp`: This can be specified twice, once with a
	//	   less than operator and once with a greater than operator. The
	//	   `timestamp` restriction should result in one, contiguous, valid,
	//	   `timestamp` range.
	//
	//	Some examples of valid filters expressions:
	//
	//	* Example 1: `timestamp > "2012-04-23T18:25:43.511Z"
	//	          timestamp < "2012-04-23t18:30:43.511z"`="" *="" example="" 2:="" `timestamp=""> "2012-04-23T18:25:43.511Z"`
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ExportAnalyticsMetrics method.

func (*ExportAnalyticsMetricsRequest) Descriptor

func (*ExportAnalyticsMetricsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportAnalyticsMetricsRequest.ProtoReflect.Descriptor instead.

func (*ExportAnalyticsMetricsRequest) GetCatalog

func (x *ExportAnalyticsMetricsRequest) GetCatalog() string

func (*ExportAnalyticsMetricsRequest) GetFilter

func (x *ExportAnalyticsMetricsRequest) GetFilter() string

func (*ExportAnalyticsMetricsRequest) GetOutputConfig

func (x *ExportAnalyticsMetricsRequest) GetOutputConfig() *OutputConfig

func (*ExportAnalyticsMetricsRequest) ProtoMessage

func (*ExportAnalyticsMetricsRequest) ProtoMessage()

func (*ExportAnalyticsMetricsRequest) ProtoReflect

func (x *ExportAnalyticsMetricsRequest) ProtoReflect() protoreflect.Message

func (*ExportAnalyticsMetricsRequest) Reset

func (x *ExportAnalyticsMetricsRequest) Reset()

func (*ExportAnalyticsMetricsRequest) String

func (x *ExportAnalyticsMetricsRequest) String() string

ExportAnalyticsMetricsResponse

type ExportAnalyticsMetricsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// This field is never set.
	ErrorsConfig *ExportErrorsConfig `protobuf:"bytes,2,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// Output result indicating where the data were exported to.
	OutputResult *OutputResult `protobuf:"bytes,3,opt,name=output_result,json=outputResult,proto3" json:"output_result,omitempty"`
	// contains filtered or unexported fields
}

Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ExportAnalyticsMetricsResponse) Descriptor

func (*ExportAnalyticsMetricsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportAnalyticsMetricsResponse.ProtoReflect.Descriptor instead.

func (*ExportAnalyticsMetricsResponse) GetErrorSamples

func (x *ExportAnalyticsMetricsResponse) GetErrorSamples() []*status.Status

func (*ExportAnalyticsMetricsResponse) GetErrorsConfig

func (x *ExportAnalyticsMetricsResponse) GetErrorsConfig() *ExportErrorsConfig

func (*ExportAnalyticsMetricsResponse) GetOutputResult

func (x *ExportAnalyticsMetricsResponse) GetOutputResult() *OutputResult

func (*ExportAnalyticsMetricsResponse) ProtoMessage

func (*ExportAnalyticsMetricsResponse) ProtoMessage()

func (*ExportAnalyticsMetricsResponse) ProtoReflect

func (x *ExportAnalyticsMetricsResponse) ProtoReflect() protoreflect.Message

func (*ExportAnalyticsMetricsResponse) Reset

func (x *ExportAnalyticsMetricsResponse) Reset()

func (*ExportAnalyticsMetricsResponse) String

func (x *ExportAnalyticsMetricsResponse) String() string

ExportErrorsConfig

type ExportErrorsConfig struct {

	// Required. Errors destination.
	//
	// Types that are assignable to Destination:
	//
	//	*ExportErrorsConfig_GcsPrefix
	Destination isExportErrorsConfig_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

Configuration of destination for Export related errors.

func (*ExportErrorsConfig) Descriptor

func (*ExportErrorsConfig) Descriptor() ([]byte, []int)

Deprecated: Use ExportErrorsConfig.ProtoReflect.Descriptor instead.

func (*ExportErrorsConfig) GetDestination

func (m *ExportErrorsConfig) GetDestination() isExportErrorsConfig_Destination

func (*ExportErrorsConfig) GetGcsPrefix

func (x *ExportErrorsConfig) GetGcsPrefix() string

func (*ExportErrorsConfig) ProtoMessage

func (*ExportErrorsConfig) ProtoMessage()

func (*ExportErrorsConfig) ProtoReflect

func (x *ExportErrorsConfig) ProtoReflect() protoreflect.Message

func (*ExportErrorsConfig) Reset

func (x *ExportErrorsConfig) Reset()

func (*ExportErrorsConfig) String

func (x *ExportErrorsConfig) String() string

ExportErrorsConfig_GcsPrefix

type ExportErrorsConfig_GcsPrefix struct {
	// Google Cloud Storage path for import errors. This must be an empty,
	// existing Cloud Storage bucket. Export errors will be written to a file in
	// this bucket, one per line, as a JSON-encoded
	// `google.rpc.Status` message.
	GcsPrefix string `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}

ExportMetadata

type ExportMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.

func (*ExportMetadata) Descriptor

func (*ExportMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ExportMetadata.ProtoReflect.Descriptor instead.

func (*ExportMetadata) GetCreateTime

func (x *ExportMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ExportMetadata) GetUpdateTime

func (x *ExportMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ExportMetadata) ProtoMessage

func (*ExportMetadata) ProtoMessage()

func (*ExportMetadata) ProtoReflect

func (x *ExportMetadata) ProtoReflect() protoreflect.Message

func (*ExportMetadata) Reset

func (x *ExportMetadata) Reset()

func (*ExportMetadata) String

func (x *ExportMetadata) String() string

ExportProductsResponse

type ExportProductsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// This field is never set.
	ErrorsConfig *ExportErrorsConfig `protobuf:"bytes,2,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// Output result indicating where the data were exported to.
	OutputResult *OutputResult `protobuf:"bytes,3,opt,name=output_result,json=outputResult,proto3" json:"output_result,omitempty"`
	// contains filtered or unexported fields
}

Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ExportProductsResponse) Descriptor

func (*ExportProductsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportProductsResponse.ProtoReflect.Descriptor instead.

func (*ExportProductsResponse) GetErrorSamples

func (x *ExportProductsResponse) GetErrorSamples() []*status.Status

func (*ExportProductsResponse) GetErrorsConfig

func (x *ExportProductsResponse) GetErrorsConfig() *ExportErrorsConfig

func (*ExportProductsResponse) GetOutputResult

func (x *ExportProductsResponse) GetOutputResult() *OutputResult

func (*ExportProductsResponse) ProtoMessage

func (*ExportProductsResponse) ProtoMessage()

func (*ExportProductsResponse) ProtoReflect

func (x *ExportProductsResponse) ProtoReflect() protoreflect.Message

func (*ExportProductsResponse) Reset

func (x *ExportProductsResponse) Reset()

func (*ExportProductsResponse) String

func (x *ExportProductsResponse) String() string

ExportUserEventsResponse

type ExportUserEventsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// This field is never set.
	ErrorsConfig *ExportErrorsConfig `protobuf:"bytes,2,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// Output result indicating where the data were exported to.
	OutputResult *OutputResult `protobuf:"bytes,3,opt,name=output_result,json=outputResult,proto3" json:"output_result,omitempty"`
	// contains filtered or unexported fields
}

Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ExportUserEventsResponse) Descriptor

func (*ExportUserEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportUserEventsResponse.ProtoReflect.Descriptor instead.

func (*ExportUserEventsResponse) GetErrorSamples

func (x *ExportUserEventsResponse) GetErrorSamples() []*status.Status

func (*ExportUserEventsResponse) GetErrorsConfig

func (x *ExportUserEventsResponse) GetErrorsConfig() *ExportErrorsConfig

func (*ExportUserEventsResponse) GetOutputResult

func (x *ExportUserEventsResponse) GetOutputResult() *OutputResult

func (*ExportUserEventsResponse) ProtoMessage

func (*ExportUserEventsResponse) ProtoMessage()

func (*ExportUserEventsResponse) ProtoReflect

func (x *ExportUserEventsResponse) ProtoReflect() protoreflect.Message

func (*ExportUserEventsResponse) Reset

func (x *ExportUserEventsResponse) Reset()

func (*ExportUserEventsResponse) String

func (x *ExportUserEventsResponse) String() string

FulfillmentInfo

type FulfillmentInfo struct {

	// The fulfillment type, including commonly used types (such as pickup in
	// store and same day delivery), and custom types. Customers have to map
	// custom types to their display names before rendering UI.
	//
	// Supported values:
	//
	// * "pickup-in-store"
	// * "ship-to-store"
	// * "same-day-delivery"
	// * "next-day-delivery"
	// * "custom-type-1"
	// * "custom-type-2"
	// * "custom-type-3"
	// * "custom-type-4"
	// * "custom-type-5"
	//
	// If this field is set to an invalid value other than these, an
	// INVALID_ARGUMENT error is returned.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// The IDs for this [type][google.cloud.retail.v2beta.FulfillmentInfo.type],
	// such as the store IDs for
	// [FulfillmentInfo.type.pickup-in-store][google.cloud.retail.v2beta.FulfillmentInfo.type]
	// or the region IDs for
	// [FulfillmentInfo.type.same-day-delivery][google.cloud.retail.v2beta.FulfillmentInfo.type].
	//
	// A maximum of 3000 values are allowed. Each value must be a string with a
	// length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such
	// as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
	// returned.
	PlaceIds []string `protobuf:"bytes,2,rep,name=place_ids,json=placeIds,proto3" json:"place_ids,omitempty"`
	// contains filtered or unexported fields
}

Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.

func (*FulfillmentInfo) Descriptor

func (*FulfillmentInfo) Descriptor() ([]byte, []int)

Deprecated: Use FulfillmentInfo.ProtoReflect.Descriptor instead.

func (*FulfillmentInfo) GetPlaceIds

func (x *FulfillmentInfo) GetPlaceIds() []string

func (*FulfillmentInfo) GetType

func (x *FulfillmentInfo) GetType() string

func (*FulfillmentInfo) ProtoMessage

func (*FulfillmentInfo) ProtoMessage()

func (*FulfillmentInfo) ProtoReflect

func (x *FulfillmentInfo) ProtoReflect() protoreflect.Message

func (*FulfillmentInfo) Reset

func (x *FulfillmentInfo) Reset()

func (*FulfillmentInfo) String

func (x *FulfillmentInfo) String() string

GcsOutputResult

type GcsOutputResult struct {

	// The uri of Gcs output
	OutputUri string `protobuf:"bytes,1,opt,name=output_uri,json=outputUri,proto3" json:"output_uri,omitempty"`
	// contains filtered or unexported fields
}

A Gcs output result.

func (*GcsOutputResult) Descriptor

func (*GcsOutputResult) Descriptor() ([]byte, []int)

Deprecated: Use GcsOutputResult.ProtoReflect.Descriptor instead.

func (*GcsOutputResult) GetOutputUri

func (x *GcsOutputResult) GetOutputUri() string

func (*GcsOutputResult) ProtoMessage

func (*GcsOutputResult) ProtoMessage()

func (*GcsOutputResult) ProtoReflect

func (x *GcsOutputResult) ProtoReflect() protoreflect.Message

func (*GcsOutputResult) Reset

func (x *GcsOutputResult) Reset()

func (*GcsOutputResult) String

func (x *GcsOutputResult) String() string

GcsSource

type GcsSource struct {

	// Required. Google Cloud Storage URIs to input files. URI can be up to
	// 2000 characters long. URIs can match the full object path (for example,
	// `gs://bucket/directory/object.json`) or a pattern matching one or more
	// files, such as `gs://bucket/directory/*.json`. A request can
	// contain at most 100 files, and each file can be up to 2 GB. See
	// [Importing product
	// information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog)
	// for the expected file format and setup instructions.
	InputUris []string `protobuf:"bytes,1,rep,name=input_uris,json=inputUris,proto3" json:"input_uris,omitempty"`
	// The schema to use when parsing the data from the source.
	//
	// Supported values for product imports:
	//
	// * `product` (default): One JSON
	// [Product][google.cloud.retail.v2beta.Product] per line. Each product must
	//
	//	have a valid [Product.id][google.cloud.retail.v2beta.Product.id].
	//   - `product_merchant_center`: See [Importing catalog data from Merchant
	//     Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).
	//
	// Supported values for user events imports:
	//
	// * `user_event` (default): One JSON
	// [UserEvent][google.cloud.retail.v2beta.UserEvent] per line.
	//   - `user_event_ga360`: Using
	//     https://support.google.com/analytics/answer/3437719.
	//
	// Supported values for control imports:
	//
	// * `control` (default): One JSON
	// [Control][google.cloud.retail.v2beta.Control] per line.
	//
	// Supported values for catalog attribute imports:
	//
	// * `catalog_attribute` (default): One CSV
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] per line.
	DataSchema string `protobuf:"bytes,2,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
	// contains filtered or unexported fields
}

Google Cloud Storage location for input content.

func (*GcsSource) Descriptor

func (*GcsSource) Descriptor() ([]byte, []int)

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetDataSchema

func (x *GcsSource) GetDataSchema() string

func (*GcsSource) GetInputUris

func (x *GcsSource) GetInputUris() []string

func (*GcsSource) ProtoMessage

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect

func (x *GcsSource) ProtoReflect() protoreflect.Message

func (*GcsSource) Reset

func (x *GcsSource) Reset()

func (*GcsSource) String

func (x *GcsSource) String() string

GetAttributesConfigRequest

type GetAttributesConfigRequest struct {

	// Required. Full AttributesConfig resource name. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.GetAttributesConfig][google.cloud.retail.v2beta.CatalogService.GetAttributesConfig] method.

func (*GetAttributesConfigRequest) Descriptor

func (*GetAttributesConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAttributesConfigRequest.ProtoReflect.Descriptor instead.

func (*GetAttributesConfigRequest) GetName

func (x *GetAttributesConfigRequest) GetName() string

func (*GetAttributesConfigRequest) ProtoMessage

func (*GetAttributesConfigRequest) ProtoMessage()

func (*GetAttributesConfigRequest) ProtoReflect

func (x *GetAttributesConfigRequest) ProtoReflect() protoreflect.Message

func (*GetAttributesConfigRequest) Reset

func (x *GetAttributesConfigRequest) Reset()

func (*GetAttributesConfigRequest) String

func (x *GetAttributesConfigRequest) String() string

GetCompletionConfigRequest

type GetCompletionConfigRequest struct {

	// Required. Full CompletionConfig resource name. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.GetCompletionConfig][google.cloud.retail.v2beta.CatalogService.GetCompletionConfig] method.

func (*GetCompletionConfigRequest) Descriptor

func (*GetCompletionConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetCompletionConfigRequest.ProtoReflect.Descriptor instead.

func (*GetCompletionConfigRequest) GetName

func (x *GetCompletionConfigRequest) GetName() string

func (*GetCompletionConfigRequest) ProtoMessage

func (*GetCompletionConfigRequest) ProtoMessage()

func (*GetCompletionConfigRequest) ProtoReflect

func (x *GetCompletionConfigRequest) ProtoReflect() protoreflect.Message

func (*GetCompletionConfigRequest) Reset

func (x *GetCompletionConfigRequest) Reset()

func (*GetCompletionConfigRequest) String

func (x *GetCompletionConfigRequest) String() string

GetControlRequest

type GetControlRequest struct {

	// Required. The resource name of the Control to get. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for GetControl method.

func (*GetControlRequest) Descriptor

func (*GetControlRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetControlRequest.ProtoReflect.Descriptor instead.

func (*GetControlRequest) GetName

func (x *GetControlRequest) GetName() string

func (*GetControlRequest) ProtoMessage

func (*GetControlRequest) ProtoMessage()

func (*GetControlRequest) ProtoReflect

func (x *GetControlRequest) ProtoReflect() protoreflect.Message

func (*GetControlRequest) Reset

func (x *GetControlRequest) Reset()

func (*GetControlRequest) String

func (x *GetControlRequest) String() string

GetDefaultBranchRequest

type GetDefaultBranchRequest struct {

	// The parent catalog resource name, such as
	// `projects/*/locations/global/catalogs/default_catalog`.
	Catalog string `protobuf:"bytes,1,opt,name=catalog,proto3" json:"catalog,omitempty"`
	// contains filtered or unexported fields
}

Request message to show which branch is currently the default branch.

func (*GetDefaultBranchRequest) Descriptor

func (*GetDefaultBranchRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDefaultBranchRequest.ProtoReflect.Descriptor instead.

func (*GetDefaultBranchRequest) GetCatalog

func (x *GetDefaultBranchRequest) GetCatalog() string

func (*GetDefaultBranchRequest) ProtoMessage

func (*GetDefaultBranchRequest) ProtoMessage()

func (*GetDefaultBranchRequest) ProtoReflect

func (x *GetDefaultBranchRequest) ProtoReflect() protoreflect.Message

func (*GetDefaultBranchRequest) Reset

func (x *GetDefaultBranchRequest) Reset()

func (*GetDefaultBranchRequest) String

func (x *GetDefaultBranchRequest) String() string

GetDefaultBranchResponse

type GetDefaultBranchResponse struct {

	// Full resource name of the branch id currently set as default branch.
	Branch string `protobuf:"bytes,1,opt,name=branch,proto3" json:"branch,omitempty"`
	// The time when this branch is set to default.
	SetTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=set_time,json=setTime,proto3" json:"set_time,omitempty"`
	// This corresponds to
	// [SetDefaultBranchRequest.note][google.cloud.retail.v2beta.SetDefaultBranchRequest.note]
	// field, when this branch was set as default.
	Note string `protobuf:"bytes,3,opt,name=note,proto3" json:"note,omitempty"`
	// contains filtered or unexported fields
}

Response message of [CatalogService.GetDefaultBranch][google.cloud.retail.v2beta.CatalogService.GetDefaultBranch].

func (*GetDefaultBranchResponse) Descriptor

func (*GetDefaultBranchResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetDefaultBranchResponse.ProtoReflect.Descriptor instead.

func (*GetDefaultBranchResponse) GetBranch

func (x *GetDefaultBranchResponse) GetBranch() string

func (*GetDefaultBranchResponse) GetNote

func (x *GetDefaultBranchResponse) GetNote() string

func (*GetDefaultBranchResponse) GetSetTime

func (x *GetDefaultBranchResponse) GetSetTime() *timestamppb.Timestamp

func (*GetDefaultBranchResponse) ProtoMessage

func (*GetDefaultBranchResponse) ProtoMessage()

func (*GetDefaultBranchResponse) ProtoReflect

func (x *GetDefaultBranchResponse) ProtoReflect() protoreflect.Message

func (*GetDefaultBranchResponse) Reset

func (x *GetDefaultBranchResponse) Reset()

func (*GetDefaultBranchResponse) String

func (x *GetDefaultBranchResponse) String() string

GetModelRequest

type GetModelRequest struct {

	// Required. The resource name of the
	// [Model][google.cloud.retail.v2beta.Model] to get. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for getting a model.

func (*GetModelRequest) Descriptor

func (*GetModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetModelRequest.ProtoReflect.Descriptor instead.

func (*GetModelRequest) GetName

func (x *GetModelRequest) GetName() string

func (*GetModelRequest) ProtoMessage

func (*GetModelRequest) ProtoMessage()

func (*GetModelRequest) ProtoReflect

func (x *GetModelRequest) ProtoReflect() protoreflect.Message

func (*GetModelRequest) Reset

func (x *GetModelRequest) Reset()

func (*GetModelRequest) String

func (x *GetModelRequest) String() string

GetProductRequest

type GetProductRequest struct {

	// Required. Full resource name of
	// [Product][google.cloud.retail.v2beta.Product], such as
	// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
	//
	// If the caller does not have permission to access the
	// [Product][google.cloud.retail.v2beta.Product], regardless of whether or not
	// it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested [Product][google.cloud.retail.v2beta.Product] does not
	// exist, a NOT_FOUND error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] method.

func (*GetProductRequest) Descriptor

func (*GetProductRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetProductRequest.ProtoReflect.Descriptor instead.

func (*GetProductRequest) GetName

func (x *GetProductRequest) GetName() string

func (*GetProductRequest) ProtoMessage

func (*GetProductRequest) ProtoMessage()

func (*GetProductRequest) ProtoReflect

func (x *GetProductRequest) ProtoReflect() protoreflect.Message

func (*GetProductRequest) Reset

func (x *GetProductRequest) Reset()

func (*GetProductRequest) String

func (x *GetProductRequest) String() string

GetServingConfigRequest

type GetServingConfigRequest struct {

	// Required. The resource name of the ServingConfig to get. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for GetServingConfig method.

func (*GetServingConfigRequest) Descriptor

func (*GetServingConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetServingConfigRequest.ProtoReflect.Descriptor instead.

func (*GetServingConfigRequest) GetName

func (x *GetServingConfigRequest) GetName() string

func (*GetServingConfigRequest) ProtoMessage

func (*GetServingConfigRequest) ProtoMessage()

func (*GetServingConfigRequest) ProtoReflect

func (x *GetServingConfigRequest) ProtoReflect() protoreflect.Message

func (*GetServingConfigRequest) Reset

func (x *GetServingConfigRequest) Reset()

func (*GetServingConfigRequest) String

func (x *GetServingConfigRequest) String() string

Image

type Image struct {

	// Required. URI of the image.
	//
	// This field must be a valid UTF-8 encoded URI with a length limit of 5,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Google Merchant Center property
	// [image_link](https://support.google.com/merchants/answer/6324350).
	// Schema.org property [Product.image](https://schema.org/image).
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Height of the image in number of pixels.
	//
	// This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is
	// returned.
	Height int32 `protobuf:"varint,2,opt,name=height,proto3" json:"height,omitempty"`
	// Width of the image in number of pixels.
	//
	// This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is
	// returned.
	Width int32 `protobuf:"varint,3,opt,name=width,proto3" json:"width,omitempty"`
	// contains filtered or unexported fields
}

[Product][google.cloud.retail.v2beta.Product] image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.

func (*Image) Descriptor

func (*Image) Descriptor() ([]byte, []int)

Deprecated: Use Image.ProtoReflect.Descriptor instead.

func (*Image) GetHeight

func (x *Image) GetHeight() int32

func (*Image) GetUri

func (x *Image) GetUri() string

func (*Image) GetWidth

func (x *Image) GetWidth() int32

func (*Image) ProtoMessage

func (*Image) ProtoMessage()

func (*Image) ProtoReflect

func (x *Image) ProtoReflect() protoreflect.Message

func (*Image) Reset

func (x *Image) Reset()

func (*Image) String

func (x *Image) String() string

ImportCompletionDataRequest

type ImportCompletionDataRequest struct {
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`

	InputConfig *CompletionDataInputConfig `protobuf:"bytes,2,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`

	NotificationPubsubTopic string "" /* 132 byte string literal not displayed */

}

Request message for ImportCompletionData methods.

func (*ImportCompletionDataRequest) Descriptor

func (*ImportCompletionDataRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportCompletionDataRequest.ProtoReflect.Descriptor instead.

func (*ImportCompletionDataRequest) GetInputConfig

func (x *ImportCompletionDataRequest) GetInputConfig() *CompletionDataInputConfig

func (*ImportCompletionDataRequest) GetNotificationPubsubTopic

func (x *ImportCompletionDataRequest) GetNotificationPubsubTopic() string

func (*ImportCompletionDataRequest) GetParent

func (x *ImportCompletionDataRequest) GetParent() string

func (*ImportCompletionDataRequest) ProtoMessage

func (*ImportCompletionDataRequest) ProtoMessage()

func (*ImportCompletionDataRequest) ProtoReflect

func (x *ImportCompletionDataRequest) ProtoReflect() protoreflect.Message

func (*ImportCompletionDataRequest) Reset

func (x *ImportCompletionDataRequest) Reset()

func (*ImportCompletionDataRequest) String

func (x *ImportCompletionDataRequest) String() string

ImportCompletionDataResponse

type ImportCompletionDataResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// contains filtered or unexported fields
}

Response of the [ImportCompletionDataRequest][google.cloud.retail.v2beta.ImportCompletionDataRequest]. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

func (*ImportCompletionDataResponse) Descriptor

func (*ImportCompletionDataResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportCompletionDataResponse.ProtoReflect.Descriptor instead.

func (*ImportCompletionDataResponse) GetErrorSamples

func (x *ImportCompletionDataResponse) GetErrorSamples() []*status.Status

func (*ImportCompletionDataResponse) ProtoMessage

func (*ImportCompletionDataResponse) ProtoMessage()

func (*ImportCompletionDataResponse) ProtoReflect

func (x *ImportCompletionDataResponse) ProtoReflect() protoreflect.Message

func (*ImportCompletionDataResponse) Reset

func (x *ImportCompletionDataResponse) Reset()

func (*ImportCompletionDataResponse) String

func (x *ImportCompletionDataResponse) String() string

ImportErrorsConfig

type ImportErrorsConfig struct {

	// Required. Errors destination.
	//
	// Types that are assignable to Destination:
	//
	//	*ImportErrorsConfig_GcsPrefix
	Destination isImportErrorsConfig_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

Configuration of destination for Import related errors.

func (*ImportErrorsConfig) Descriptor

func (*ImportErrorsConfig) Descriptor() ([]byte, []int)

Deprecated: Use ImportErrorsConfig.ProtoReflect.Descriptor instead.

func (*ImportErrorsConfig) GetDestination

func (m *ImportErrorsConfig) GetDestination() isImportErrorsConfig_Destination

func (*ImportErrorsConfig) GetGcsPrefix

func (x *ImportErrorsConfig) GetGcsPrefix() string

func (*ImportErrorsConfig) ProtoMessage

func (*ImportErrorsConfig) ProtoMessage()

func (*ImportErrorsConfig) ProtoReflect

func (x *ImportErrorsConfig) ProtoReflect() protoreflect.Message

func (*ImportErrorsConfig) Reset

func (x *ImportErrorsConfig) Reset()

func (*ImportErrorsConfig) String

func (x *ImportErrorsConfig) String() string

ImportErrorsConfig_GcsPrefix

type ImportErrorsConfig_GcsPrefix struct {
	// Google Cloud Storage prefix for import errors. This must be an empty,
	// existing Cloud Storage directory. Import errors are written to
	// sharded files in this directory, one per line, as a JSON-encoded
	// `google.rpc.Status` message.
	GcsPrefix string `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}

ImportMetadata

type ImportMetadata struct {
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`

	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`

	RequestId string `protobuf:"bytes,5,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`

	NotificationPubsubTopic string "" /* 132 byte string literal not displayed */

}

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

func (*ImportMetadata) Descriptor

func (*ImportMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportMetadata.ProtoReflect.Descriptor instead.

func (*ImportMetadata) GetCreateTime

func (x *ImportMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ImportMetadata) GetFailureCount

func (x *ImportMetadata) GetFailureCount() int64

func (*ImportMetadata) GetNotificationPubsubTopic

func (x *ImportMetadata) GetNotificationPubsubTopic() string

func (*ImportMetadata) GetRequestId

func (x *ImportMetadata) GetRequestId() string

Deprecated: Marked as deprecated in google/cloud/retail/v2beta/import_config.proto.

func (*ImportMetadata) GetSuccessCount

func (x *ImportMetadata) GetSuccessCount() int64

func (*ImportMetadata) GetUpdateTime

func (x *ImportMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ImportMetadata) ProtoMessage

func (*ImportMetadata) ProtoMessage()

func (*ImportMetadata) ProtoReflect

func (x *ImportMetadata) ProtoReflect() protoreflect.Message

func (*ImportMetadata) Reset

func (x *ImportMetadata) Reset()

func (*ImportMetadata) String

func (x *ImportMetadata) String() string

ImportProductsRequest

type ImportProductsRequest struct {
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`

	RequestId string `protobuf:"bytes,6,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`

	InputConfig *ProductInputConfig `protobuf:"bytes,2,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`

	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,3,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`

	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`

	ReconciliationMode ImportProductsRequest_ReconciliationMode "" /* 189 byte string literal not displayed */

	NotificationPubsubTopic string "" /* 132 byte string literal not displayed */

}

Request message for Import methods.

func (*ImportProductsRequest) Descriptor

func (*ImportProductsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportProductsRequest.ProtoReflect.Descriptor instead.

func (*ImportProductsRequest) GetErrorsConfig

func (x *ImportProductsRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportProductsRequest) GetInputConfig

func (x *ImportProductsRequest) GetInputConfig() *ProductInputConfig

func (*ImportProductsRequest) GetNotificationPubsubTopic

func (x *ImportProductsRequest) GetNotificationPubsubTopic() string

func (*ImportProductsRequest) GetParent

func (x *ImportProductsRequest) GetParent() string

func (*ImportProductsRequest) GetReconciliationMode

func (x *ImportProductsRequest) GetReconciliationMode() ImportProductsRequest_ReconciliationMode

func (*ImportProductsRequest) GetRequestId

func (x *ImportProductsRequest) GetRequestId() string

Deprecated: Marked as deprecated in google/cloud/retail/v2beta/import_config.proto.

func (*ImportProductsRequest) GetUpdateMask

func (x *ImportProductsRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*ImportProductsRequest) ProtoMessage

func (*ImportProductsRequest) ProtoMessage()

func (*ImportProductsRequest) ProtoReflect

func (x *ImportProductsRequest) ProtoReflect() protoreflect.Message

func (*ImportProductsRequest) Reset

func (x *ImportProductsRequest) Reset()

func (*ImportProductsRequest) String

func (x *ImportProductsRequest) String() string

ImportProductsRequest_ReconciliationMode

type ImportProductsRequest_ReconciliationMode int32

Indicates how imported products are reconciled with the existing products created or imported before.

ImportProductsRequest_RECONCILIATION_MODE_UNSPECIFIED, ImportProductsRequest_INCREMENTAL, ImportProductsRequest_FULL

const (
	// Defaults to INCREMENTAL.
	ImportProductsRequest_RECONCILIATION_MODE_UNSPECIFIED ImportProductsRequest_ReconciliationMode = 0
	// Inserts new products or updates existing products.
	ImportProductsRequest_INCREMENTAL ImportProductsRequest_ReconciliationMode = 1
	// Calculates diff and replaces the entire product dataset. Existing
	// products may be deleted if they are not present in the source location.
	ImportProductsRequest_FULL ImportProductsRequest_ReconciliationMode = 2
)

func (ImportProductsRequest_ReconciliationMode) Descriptor

func (ImportProductsRequest_ReconciliationMode) Descriptor() protoreflect.EnumDescriptor

func (ImportProductsRequest_ReconciliationMode) Enum

func (x ImportProductsRequest_ReconciliationMode) Enum() *ImportProductsRequest_ReconciliationMode

func (ImportProductsRequest_ReconciliationMode) EnumDescriptor

func (ImportProductsRequest_ReconciliationMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImportProductsRequest_ReconciliationMode.Descriptor instead.

func (ImportProductsRequest_ReconciliationMode) Number

func (x ImportProductsRequest_ReconciliationMode) Number() protoreflect.EnumNumber

func (ImportProductsRequest_ReconciliationMode) String

func (x ImportProductsRequest_ReconciliationMode) String() string

func (ImportProductsRequest_ReconciliationMode) Type

func (ImportProductsRequest_ReconciliationMode) Type() protoreflect.EnumType

ImportProductsResponse

type ImportProductsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// Echoes the destination for the complete errors in the request if set.
	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,2,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// contains filtered or unexported fields
}

Response of the [ImportProductsRequest][google.cloud.retail.v2beta.ImportProductsRequest]. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ImportProductsResponse) Descriptor

func (*ImportProductsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportProductsResponse.ProtoReflect.Descriptor instead.

func (*ImportProductsResponse) GetErrorSamples

func (x *ImportProductsResponse) GetErrorSamples() []*status.Status

func (*ImportProductsResponse) GetErrorsConfig

func (x *ImportProductsResponse) GetErrorsConfig() *ImportErrorsConfig

func (*ImportProductsResponse) ProtoMessage

func (*ImportProductsResponse) ProtoMessage()

func (*ImportProductsResponse) ProtoReflect

func (x *ImportProductsResponse) ProtoReflect() protoreflect.Message

func (*ImportProductsResponse) Reset

func (x *ImportProductsResponse) Reset()

func (*ImportProductsResponse) String

func (x *ImportProductsResponse) String() string

ImportUserEventsRequest

type ImportUserEventsRequest struct {

	// Required. `projects/1234/locations/global/catalogs/default_catalog`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The desired input location of the data.
	InputConfig *UserEventInputConfig `protobuf:"bytes,2,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// The desired location of errors incurred during the Import. Cannot be set
	// for inline user event imports.
	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,3,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ImportUserEvents request.

func (*ImportUserEventsRequest) Descriptor

func (*ImportUserEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsRequest.ProtoReflect.Descriptor instead.

func (*ImportUserEventsRequest) GetErrorsConfig

func (x *ImportUserEventsRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportUserEventsRequest) GetInputConfig

func (x *ImportUserEventsRequest) GetInputConfig() *UserEventInputConfig

func (*ImportUserEventsRequest) GetParent

func (x *ImportUserEventsRequest) GetParent() string

func (*ImportUserEventsRequest) ProtoMessage

func (*ImportUserEventsRequest) ProtoMessage()

func (*ImportUserEventsRequest) ProtoReflect

func (x *ImportUserEventsRequest) ProtoReflect() protoreflect.Message

func (*ImportUserEventsRequest) Reset

func (x *ImportUserEventsRequest) Reset()

func (*ImportUserEventsRequest) String

func (x *ImportUserEventsRequest) String() string

ImportUserEventsResponse

type ImportUserEventsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// Echoes the destination for the complete errors if this field was set in
	// the request.
	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,2,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// Aggregated statistics of user event import status.
	ImportSummary *UserEventImportSummary `protobuf:"bytes,3,opt,name=import_summary,json=importSummary,proto3" json:"import_summary,omitempty"`
	// contains filtered or unexported fields
}

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ImportUserEventsResponse) Descriptor

func (*ImportUserEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsResponse.ProtoReflect.Descriptor instead.

func (*ImportUserEventsResponse) GetErrorSamples

func (x *ImportUserEventsResponse) GetErrorSamples() []*status.Status

func (*ImportUserEventsResponse) GetErrorsConfig

func (x *ImportUserEventsResponse) GetErrorsConfig() *ImportErrorsConfig

func (*ImportUserEventsResponse) GetImportSummary

func (x *ImportUserEventsResponse) GetImportSummary() *UserEventImportSummary

func (*ImportUserEventsResponse) ProtoMessage

func (*ImportUserEventsResponse) ProtoMessage()

func (*ImportUserEventsResponse) ProtoReflect

func (x *ImportUserEventsResponse) ProtoReflect() protoreflect.Message

func (*ImportUserEventsResponse) Reset

func (x *ImportUserEventsResponse) Reset()

func (*ImportUserEventsResponse) String

func (x *ImportUserEventsResponse) String() string

Interval

type Interval struct {

	// The lower bound of the interval. If neither of the min fields are set, then
	// the lower bound is negative infinity.
	//
	// This field must not be larger than max.
	// Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Types that are assignable to Min:
	//
	//	*Interval_Minimum
	//	*Interval_ExclusiveMinimum
	Min isInterval_Min `protobuf_oneof:"min"`
	// The upper bound of the interval. If neither of the max fields are set, then
	// the upper bound is positive infinity.
	//
	// This field must be not smaller than min.
	// Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Types that are assignable to Max:
	//
	//	*Interval_Maximum
	//	*Interval_ExclusiveMaximum
	Max isInterval_Max `protobuf_oneof:"max"`
	// contains filtered or unexported fields
}

A floating point interval.

func (*Interval) Descriptor

func (*Interval) Descriptor() ([]byte, []int)

Deprecated: Use Interval.ProtoReflect.Descriptor instead.

func (*Interval) GetExclusiveMaximum

func (x *Interval) GetExclusiveMaximum() float64

func (*Interval) GetExclusiveMinimum

func (x *Interval) GetExclusiveMinimum() float64

func (*Interval) GetMax

func (m *Interval) GetMax() isInterval_Max

func (*Interval) GetMaximum

func (x *Interval) GetMaximum() float64

func (*Interval) GetMin

func (m *Interval) GetMin() isInterval_Min

func (*Interval) GetMinimum

func (x *Interval) GetMinimum() float64

func (*Interval) ProtoMessage

func (*Interval) ProtoMessage()

func (*Interval) ProtoReflect

func (x *Interval) ProtoReflect() protoreflect.Message

func (*Interval) Reset

func (x *Interval) Reset()

func (*Interval) String

func (x *Interval) String() string

Interval_ExclusiveMaximum

type Interval_ExclusiveMaximum struct {
	// Exclusive upper bound.
	ExclusiveMaximum float64 `protobuf:"fixed64,4,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3,oneof"`
}

Interval_ExclusiveMinimum

type Interval_ExclusiveMinimum struct {
	// Exclusive lower bound.
	ExclusiveMinimum float64 `protobuf:"fixed64,2,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3,oneof"`
}

Interval_Maximum

type Interval_Maximum struct {
	// Inclusive upper bound.
	Maximum float64 `protobuf:"fixed64,3,opt,name=maximum,proto3,oneof"`
}

Interval_Minimum

type Interval_Minimum struct {
	// Inclusive lower bound.
	Minimum float64 `protobuf:"fixed64,1,opt,name=minimum,proto3,oneof"`
}

ListCatalogsRequest

type ListCatalogsRequest struct {

	// Required. The account resource name with an associated location.
	//
	// If the caller does not have permission to list
	// [Catalog][google.cloud.retail.v2beta.Catalog]s under this location,
	// regardless of whether or not this location exists, a PERMISSION_DENIED
	// error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of [Catalog][google.cloud.retail.v2beta.Catalog]s to return.
	// If unspecified, defaults to 50. The maximum allowed value is 1000. Values
	// above 1000 will be coerced to 1000.
	//
	// If this field is negative, an INVALID_ARGUMENT is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListCatalogsResponse.next_page_token][google.cloud.retail.v2beta.ListCatalogsResponse.next_page_token],
	// received from a previous
	// [CatalogService.ListCatalogs][google.cloud.retail.v2beta.CatalogService.ListCatalogs]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [CatalogService.ListCatalogs][google.cloud.retail.v2beta.CatalogService.ListCatalogs]
	// must match the call that provided the page token. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.ListCatalogs][google.cloud.retail.v2beta.CatalogService.ListCatalogs] method.

func (*ListCatalogsRequest) Descriptor

func (*ListCatalogsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListCatalogsRequest.ProtoReflect.Descriptor instead.

func (*ListCatalogsRequest) GetPageSize

func (x *ListCatalogsRequest) GetPageSize() int32

func (*ListCatalogsRequest) GetPageToken

func (x *ListCatalogsRequest) GetPageToken() string

func (*ListCatalogsRequest) GetParent

func (x *ListCatalogsRequest) GetParent() string

func (*ListCatalogsRequest) ProtoMessage

func (*ListCatalogsRequest) ProtoMessage()

func (*ListCatalogsRequest) ProtoReflect

func (x *ListCatalogsRequest) ProtoReflect() protoreflect.Message

func (*ListCatalogsRequest) Reset

func (x *ListCatalogsRequest) Reset()

func (*ListCatalogsRequest) String

func (x *ListCatalogsRequest) String() string

ListCatalogsResponse

type ListCatalogsResponse struct {

	// All the customer's [Catalog][google.cloud.retail.v2beta.Catalog]s.
	Catalogs []*Catalog `protobuf:"bytes,1,rep,name=catalogs,proto3" json:"catalogs,omitempty"`
	// A token that can be sent as
	// [ListCatalogsRequest.page_token][google.cloud.retail.v2beta.ListCatalogsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for [CatalogService.ListCatalogs][google.cloud.retail.v2beta.CatalogService.ListCatalogs] method.

func (*ListCatalogsResponse) Descriptor

func (*ListCatalogsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListCatalogsResponse.ProtoReflect.Descriptor instead.

func (*ListCatalogsResponse) GetCatalogs

func (x *ListCatalogsResponse) GetCatalogs() []*Catalog

func (*ListCatalogsResponse) GetNextPageToken

func (x *ListCatalogsResponse) GetNextPageToken() string

func (*ListCatalogsResponse) ProtoMessage

func (*ListCatalogsResponse) ProtoMessage()

func (*ListCatalogsResponse) ProtoReflect

func (x *ListCatalogsResponse) ProtoReflect() protoreflect.Message

func (*ListCatalogsResponse) Reset

func (x *ListCatalogsResponse) Reset()

func (*ListCatalogsResponse) String

func (x *ListCatalogsResponse) String() string

ListControlsRequest

type ListControlsRequest struct {

	// Required. The catalog resource name. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Maximum number of results to return. If unspecified, defaults
	// to 50. Max allowed value is 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListControls` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter to apply on the list results. Supported features:
	//
	// * List all the products under the parent branch if
	// [filter][google.cloud.retail.v2beta.ListControlsRequest.filter] is unset.
	//   - List controls that are used in a single ServingConfig:
	//     'serving_config = "boosted_home_page_cvr"'
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request for ListControls method.

func (*ListControlsRequest) Descriptor

func (*ListControlsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListControlsRequest.ProtoReflect.Descriptor instead.

func (*ListControlsRequest) GetFilter

func (x *ListControlsRequest) GetFilter() string

func (*ListControlsRequest) GetPageSize

func (x *ListControlsRequest) GetPageSize() int32

func (*ListControlsRequest) GetPageToken

func (x *ListControlsRequest) GetPageToken() string

func (*ListControlsRequest) GetParent

func (x *ListControlsRequest) GetParent() string

func (*ListControlsRequest) ProtoMessage

func (*ListControlsRequest) ProtoMessage()

func (*ListControlsRequest) ProtoReflect

func (x *ListControlsRequest) ProtoReflect() protoreflect.Message

func (*ListControlsRequest) Reset

func (x *ListControlsRequest) Reset()

func (*ListControlsRequest) String

func (x *ListControlsRequest) String() string

ListControlsResponse

type ListControlsResponse struct {

	// All the Controls for a given catalog.
	Controls []*Control `protobuf:"bytes,1,rep,name=controls,proto3" json:"controls,omitempty"`
	// Pagination token, if not returned indicates the last page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for ListControls method.

func (*ListControlsResponse) Descriptor

func (*ListControlsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListControlsResponse.ProtoReflect.Descriptor instead.

func (*ListControlsResponse) GetControls

func (x *ListControlsResponse) GetControls() []*Control

func (*ListControlsResponse) GetNextPageToken

func (x *ListControlsResponse) GetNextPageToken() string

func (*ListControlsResponse) ProtoMessage

func (*ListControlsResponse) ProtoMessage()

func (*ListControlsResponse) ProtoReflect

func (x *ListControlsResponse) ProtoReflect() protoreflect.Message

func (*ListControlsResponse) Reset

func (x *ListControlsResponse) Reset()

func (*ListControlsResponse) String

func (x *ListControlsResponse) String() string

ListModelsRequest

type ListModelsRequest struct {

	// Required. The parent for which to list models.
	// Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Maximum number of results to return. If unspecified, defaults
	// to 50. Max allowed value is 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListModels`
	// call. Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for listing models associated with a resource.

func (*ListModelsRequest) Descriptor

func (*ListModelsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListModelsRequest.ProtoReflect.Descriptor instead.

func (*ListModelsRequest) GetPageSize

func (x *ListModelsRequest) GetPageSize() int32

func (*ListModelsRequest) GetPageToken

func (x *ListModelsRequest) GetPageToken() string

func (*ListModelsRequest) GetParent

func (x *ListModelsRequest) GetParent() string

func (*ListModelsRequest) ProtoMessage

func (*ListModelsRequest) ProtoMessage()

func (*ListModelsRequest) ProtoReflect

func (x *ListModelsRequest) ProtoReflect() protoreflect.Message

func (*ListModelsRequest) Reset

func (x *ListModelsRequest) Reset()

func (*ListModelsRequest) String

func (x *ListModelsRequest) String() string

ListModelsResponse

type ListModelsResponse struct {

	// List of Models.
	Models []*Model `protobuf:"bytes,1,rep,name=models,proto3" json:"models,omitempty"`
	// Pagination token, if not returned indicates the last page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response to a ListModelRequest.

func (*ListModelsResponse) Descriptor

func (*ListModelsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListModelsResponse.ProtoReflect.Descriptor instead.

func (*ListModelsResponse) GetModels

func (x *ListModelsResponse) GetModels() []*Model

func (*ListModelsResponse) GetNextPageToken

func (x *ListModelsResponse) GetNextPageToken() string

func (*ListModelsResponse) ProtoMessage

func (*ListModelsResponse) ProtoMessage()

func (*ListModelsResponse) ProtoReflect

func (x *ListModelsResponse) ProtoReflect() protoreflect.Message

func (*ListModelsResponse) Reset

func (x *ListModelsResponse) Reset()

func (*ListModelsResponse) String

func (x *ListModelsResponse) String() string

ListProductsRequest

type ListProductsRequest struct {

	// Required. The parent branch resource name, such as
	// `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use
	// `default_branch` as the branch ID, to list products under the default
	// branch.
	//
	// If the caller does not have permission to list
	// [Product][google.cloud.retail.v2beta.Product]s under this branch,
	// regardless of whether or not this branch exists, a PERMISSION_DENIED error
	// is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of [Product][google.cloud.retail.v2beta.Product]s to return.
	// If unspecified, defaults to 100. The maximum allowed value is 1000. Values
	// above 1000 will be coerced to 1000.
	//
	// If this field is negative, an INVALID_ARGUMENT error is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListProductsResponse.next_page_token][google.cloud.retail.v2beta.ListProductsResponse.next_page_token],
	// received from a previous
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts]
	// must match the call that provided the page token. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A filter to apply on the list results. Supported features:
	//
	// * List all the products under the parent branch if
	// [filter][google.cloud.retail.v2beta.ListProductsRequest.filter] is unset.
	// * List
	// [Product.Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2beta.Product]s sharing the same
	//
	//	[Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
	//	[Product][google.cloud.retail.v2beta.Product]. For example:
	//	  `primary_product_id = "some_product_id"`
	//
	// * List [Product][google.cloud.retail.v2beta.Product]s bundled in a
	// [Product.Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]
	// [Product][google.cloud.retail.v2beta.Product].
	//
	//	For example:
	//	  `collection_product_id = "some_product_id"`
	//
	// * List [Product][google.cloud.retail.v2beta.Product]s with a partibular
	// type. For example:
	//
	//	`type = "PRIMARY"`
	//	`type = "VARIANT"`
	//	`type = "COLLECTION"`
	//
	// If the field is unrecognizable, an INVALID_ARGUMENT error is returned.
	//
	// If the specified
	// [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2beta.Product] or
	// [Product.Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]
	// [Product][google.cloud.retail.v2beta.Product] does not exist, a NOT_FOUND
	// error is returned.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// The fields of [Product][google.cloud.retail.v2beta.Product] to return in
	// the responses. If not set or empty, the following fields are returned:
	//
	// * [Product.name][google.cloud.retail.v2beta.Product.name]
	// * [Product.id][google.cloud.retail.v2beta.Product.id]
	// * [Product.title][google.cloud.retail.v2beta.Product.title]
	// * [Product.uri][google.cloud.retail.v2beta.Product.uri]
	// * [Product.images][google.cloud.retail.v2beta.Product.images]
	// * [Product.price_info][google.cloud.retail.v2beta.Product.price_info]
	// * [Product.brands][google.cloud.retail.v2beta.Product.brands]
	//
	// If "*" is provided, all fields are returned.
	// [Product.name][google.cloud.retail.v2beta.Product.name] is always returned
	// no matter what mask is set.
	//
	// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
	// is returned.
	ReadMask *fieldmaskpb.FieldMask `protobuf:"bytes,5,opt,name=read_mask,json=readMask,proto3" json:"read_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts] method.

func (*ListProductsRequest) Descriptor

func (*ListProductsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListProductsRequest.ProtoReflect.Descriptor instead.

func (*ListProductsRequest) GetFilter

func (x *ListProductsRequest) GetFilter() string

func (*ListProductsRequest) GetPageSize

func (x *ListProductsRequest) GetPageSize() int32

func (*ListProductsRequest) GetPageToken

func (x *ListProductsRequest) GetPageToken() string

func (*ListProductsRequest) GetParent

func (x *ListProductsRequest) GetParent() string

func (*ListProductsRequest) GetReadMask

func (x *ListProductsRequest) GetReadMask() *fieldmaskpb.FieldMask

func (*ListProductsRequest) ProtoMessage

func (*ListProductsRequest) ProtoMessage()

func (*ListProductsRequest) ProtoReflect

func (x *ListProductsRequest) ProtoReflect() protoreflect.Message

func (*ListProductsRequest) Reset

func (x *ListProductsRequest) Reset()

func (*ListProductsRequest) String

func (x *ListProductsRequest) String() string

ListProductsResponse

type ListProductsResponse struct {

	// The [Product][google.cloud.retail.v2beta.Product]s.
	Products []*Product `protobuf:"bytes,1,rep,name=products,proto3" json:"products,omitempty"`
	// A token that can be sent as
	// [ListProductsRequest.page_token][google.cloud.retail.v2beta.ListProductsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts] method.

func (*ListProductsResponse) Descriptor

func (*ListProductsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListProductsResponse.ProtoReflect.Descriptor instead.

func (*ListProductsResponse) GetNextPageToken

func (x *ListProductsResponse) GetNextPageToken() string

func (*ListProductsResponse) GetProducts

func (x *ListProductsResponse) GetProducts() []*Product

func (*ListProductsResponse) ProtoMessage

func (*ListProductsResponse) ProtoMessage()

func (*ListProductsResponse) ProtoReflect

func (x *ListProductsResponse) ProtoReflect() protoreflect.Message

func (*ListProductsResponse) Reset

func (x *ListProductsResponse) Reset()

func (*ListProductsResponse) String

func (x *ListProductsResponse) String() string

ListServingConfigsRequest

type ListServingConfigsRequest struct {

	// Required. The catalog resource name. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Maximum number of results to return. If unspecified, defaults
	// to 100. If a value greater than 100 is provided, at most 100 results are
	// returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListServingConfigs` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for ListServingConfigs method.

func (*ListServingConfigsRequest) Descriptor

func (*ListServingConfigsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListServingConfigsRequest.ProtoReflect.Descriptor instead.

func (*ListServingConfigsRequest) GetPageSize

func (x *ListServingConfigsRequest) GetPageSize() int32

func (*ListServingConfigsRequest) GetPageToken

func (x *ListServingConfigsRequest) GetPageToken() string

func (*ListServingConfigsRequest) GetParent

func (x *ListServingConfigsRequest) GetParent() string

func (*ListServingConfigsRequest) ProtoMessage

func (*ListServingConfigsRequest) ProtoMessage()

func (*ListServingConfigsRequest) ProtoReflect

func (x *ListServingConfigsRequest) ProtoReflect() protoreflect.Message

func (*ListServingConfigsRequest) Reset

func (x *ListServingConfigsRequest) Reset()

func (*ListServingConfigsRequest) String

func (x *ListServingConfigsRequest) String() string

ListServingConfigsResponse

type ListServingConfigsResponse struct {

	// All the ServingConfigs for a given catalog.
	ServingConfigs []*ServingConfig `protobuf:"bytes,1,rep,name=serving_configs,json=servingConfigs,proto3" json:"serving_configs,omitempty"`
	// Pagination token, if not returned indicates the last page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for ListServingConfigs method.

func (*ListServingConfigsResponse) Descriptor

func (*ListServingConfigsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListServingConfigsResponse.ProtoReflect.Descriptor instead.

func (*ListServingConfigsResponse) GetNextPageToken

func (x *ListServingConfigsResponse) GetNextPageToken() string

func (*ListServingConfigsResponse) GetServingConfigs

func (x *ListServingConfigsResponse) GetServingConfigs() []*ServingConfig

func (*ListServingConfigsResponse) ProtoMessage

func (*ListServingConfigsResponse) ProtoMessage()

func (*ListServingConfigsResponse) ProtoReflect

func (x *ListServingConfigsResponse) ProtoReflect() protoreflect.Message

func (*ListServingConfigsResponse) Reset

func (x *ListServingConfigsResponse) Reset()

func (*ListServingConfigsResponse) String

func (x *ListServingConfigsResponse) String() string

LocalInventory

type LocalInventory struct {
	PlaceId string `protobuf:"bytes,1,opt,name=place_id,json=placeId,proto3" json:"place_id,omitempty"`

	PriceInfo *PriceInfo `protobuf:"bytes,2,opt,name=price_info,json=priceInfo,proto3" json:"price_info,omitempty"`

	Attributes map[string]*CustomAttribute "" /* 161 byte string literal not displayed */

	FulfillmentTypes []string `protobuf:"bytes,4,rep,name=fulfillment_types,json=fulfillmentTypes,proto3" json:"fulfillment_types,omitempty"`

}

The inventory information at a place (e.g. a store) identified by a place ID.

func (*LocalInventory) Descriptor

func (*LocalInventory) Descriptor() ([]byte, []int)

Deprecated: Use LocalInventory.ProtoReflect.Descriptor instead.

func (*LocalInventory) GetAttributes

func (x *LocalInventory) GetAttributes() map[string]*CustomAttribute

func (*LocalInventory) GetFulfillmentTypes

func (x *LocalInventory) GetFulfillmentTypes() []string

func (*LocalInventory) GetPlaceId

func (x *LocalInventory) GetPlaceId() string

func (*LocalInventory) GetPriceInfo

func (x *LocalInventory) GetPriceInfo() *PriceInfo

func (*LocalInventory) ProtoMessage

func (*LocalInventory) ProtoMessage()

func (*LocalInventory) ProtoReflect

func (x *LocalInventory) ProtoReflect() protoreflect.Message

func (*LocalInventory) Reset

func (x *LocalInventory) Reset()

func (*LocalInventory) String

func (x *LocalInventory) String() string

MerchantCenterFeedFilter

type MerchantCenterFeedFilter struct {

	// Merchant Center primary feed ID.
	PrimaryFeedId int64 `protobuf:"varint,1,opt,name=primary_feed_id,json=primaryFeedId,proto3" json:"primary_feed_id,omitempty"`
	// Merchant Center primary feed name. The name is used for the display
	// purposes only.
	PrimaryFeedName string `protobuf:"bytes,2,opt,name=primary_feed_name,json=primaryFeedName,proto3" json:"primary_feed_name,omitempty"`
	// contains filtered or unexported fields
}

Merchant Center Feed filter criterion.

func (*MerchantCenterFeedFilter) Descriptor

func (*MerchantCenterFeedFilter) Descriptor() ([]byte, []int)

Deprecated: Use MerchantCenterFeedFilter.ProtoReflect.Descriptor instead.

func (*MerchantCenterFeedFilter) GetPrimaryFeedId

func (x *MerchantCenterFeedFilter) GetPrimaryFeedId() int64

func (*MerchantCenterFeedFilter) GetPrimaryFeedName

func (x *MerchantCenterFeedFilter) GetPrimaryFeedName() string

func (*MerchantCenterFeedFilter) ProtoMessage

func (*MerchantCenterFeedFilter) ProtoMessage()

func (*MerchantCenterFeedFilter) ProtoReflect

func (x *MerchantCenterFeedFilter) ProtoReflect() protoreflect.Message

func (*MerchantCenterFeedFilter) Reset

func (x *MerchantCenterFeedFilter) Reset()

func (*MerchantCenterFeedFilter) String

func (x *MerchantCenterFeedFilter) String() string

MerchantCenterLink

type MerchantCenterLink struct {
	MerchantCenterAccountId int64 "" /* 135 byte string literal not displayed */

	BranchId string `protobuf:"bytes,2,opt,name=branch_id,json=branchId,proto3" json:"branch_id,omitempty"`

	Destinations []string `protobuf:"bytes,3,rep,name=destinations,proto3" json:"destinations,omitempty"`

	RegionCode string `protobuf:"bytes,4,opt,name=region_code,json=regionCode,proto3" json:"region_code,omitempty"`

	LanguageCode string `protobuf:"bytes,5,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`

	Feeds []*MerchantCenterFeedFilter `protobuf:"bytes,6,rep,name=feeds,proto3" json:"feeds,omitempty"`

}

Represents a link between a Merchant Center account and a branch. Once a link is established, products from the linked merchant center account will be streamed to the linked branch.

func (*MerchantCenterLink) Descriptor

func (*MerchantCenterLink) Descriptor() ([]byte, []int)

Deprecated: Use MerchantCenterLink.ProtoReflect.Descriptor instead.

func (*MerchantCenterLink) GetBranchId

func (x *MerchantCenterLink) GetBranchId() string

func (*MerchantCenterLink) GetDestinations

func (x *MerchantCenterLink) GetDestinations() []string

func (*MerchantCenterLink) GetFeeds

func (x *MerchantCenterLink) GetFeeds() []*MerchantCenterFeedFilter

func (*MerchantCenterLink) GetLanguageCode

func (x *MerchantCenterLink) GetLanguageCode() string

func (*MerchantCenterLink) GetMerchantCenterAccountId

func (x *MerchantCenterLink) GetMerchantCenterAccountId() int64

func (*MerchantCenterLink) GetRegionCode

func (x *MerchantCenterLink) GetRegionCode() string

func (*MerchantCenterLink) ProtoMessage

func (*MerchantCenterLink) ProtoMessage()

func (*MerchantCenterLink) ProtoReflect

func (x *MerchantCenterLink) ProtoReflect() protoreflect.Message

func (*MerchantCenterLink) Reset

func (x *MerchantCenterLink) Reset()

func (*MerchantCenterLink) String

func (x *MerchantCenterLink) String() string

MerchantCenterLinkingConfig

type MerchantCenterLinkingConfig struct {

	// Links between Merchant Center accounts and branches.
	Links []*MerchantCenterLink `protobuf:"bytes,1,rep,name=links,proto3" json:"links,omitempty"`
	// contains filtered or unexported fields
}

Configures Merchant Center linking. Links contained in the config will be used to sync data from a Merchant Center account to a Cloud Retail branch.

func (*MerchantCenterLinkingConfig) Descriptor

func (*MerchantCenterLinkingConfig) Descriptor() ([]byte, []int)

Deprecated: Use MerchantCenterLinkingConfig.ProtoReflect.Descriptor instead.

func (*MerchantCenterLinkingConfig) GetLinks

func (x *MerchantCenterLinkingConfig) GetLinks() []*MerchantCenterLink

func (*MerchantCenterLinkingConfig) ProtoMessage

func (*MerchantCenterLinkingConfig) ProtoMessage()

func (*MerchantCenterLinkingConfig) ProtoReflect

func (x *MerchantCenterLinkingConfig) ProtoReflect() protoreflect.Message

func (*MerchantCenterLinkingConfig) Reset

func (x *MerchantCenterLinkingConfig) Reset()

func (*MerchantCenterLinkingConfig) String

func (x *MerchantCenterLinkingConfig) String() string

Model

type Model struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`

	TrainingState Model_TrainingState "" /* 153 byte string literal not displayed */

	ServingState Model_ServingState "" /* 149 byte string literal not displayed */

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

	Type string `protobuf:"bytes,7,opt,name=type,proto3" json:"type,omitempty"`

	OptimizationObjective string `protobuf:"bytes,8,opt,name=optimization_objective,json=optimizationObjective,proto3" json:"optimization_objective,omitempty"`

	PeriodicTuningState Model_PeriodicTuningState "" /* 180 byte string literal not displayed */

	LastTuneTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=last_tune_time,json=lastTuneTime,proto3" json:"last_tune_time,omitempty"`

	TuningOperation string `protobuf:"bytes,15,opt,name=tuning_operation,json=tuningOperation,proto3" json:"tuning_operation,omitempty"`

	DataState Model_DataState "" /* 138 byte string literal not displayed */

	FilteringOption RecommendationsFilteringOption "" /* 171 byte string literal not displayed */

	ServingConfigLists []*Model_ServingConfigList `protobuf:"bytes,19,rep,name=serving_config_lists,json=servingConfigLists,proto3" json:"serving_config_lists,omitempty"`

}

Metadata that describes the training and serving parameters of a [Model][google.cloud.retail.v2beta.Model]. A [Model][google.cloud.retail.v2beta.Model] can be associated with a [ServingConfig][google.cloud.retail.v2beta.ServingConfig] and then queried through the Predict API.

func (*Model) Descriptor

func (*Model) Descriptor() ([]byte, []int)

Deprecated: Use Model.ProtoReflect.Descriptor instead.

func (*Model) GetCreateTime

func (x *Model) GetCreateTime() *timestamppb.Timestamp

func (*Model) GetDataState

func (x *Model) GetDataState() Model_DataState

func (*Model) GetDisplayName

func (x *Model) GetDisplayName() string

func (*Model) GetFilteringOption

func (x *Model) GetFilteringOption() RecommendationsFilteringOption

func (*Model) GetLastTuneTime

func (x *Model) GetLastTuneTime() *timestamppb.Timestamp

func (*Model) GetName

func (x *Model) GetName() string

func (*Model) GetOptimizationObjective

func (x *Model) GetOptimizationObjective() string

func (*Model) GetPeriodicTuningState

func (x *Model) GetPeriodicTuningState() Model_PeriodicTuningState

func (*Model) GetServingConfigLists

func (x *Model) GetServingConfigLists() []*Model_ServingConfigList

func (*Model) GetServingState

func (x *Model) GetServingState() Model_ServingState

func (*Model) GetTrainingState

func (x *Model) GetTrainingState() Model_TrainingState

func (*Model) GetTuningOperation

func (x *Model) GetTuningOperation() string

func (*Model) GetType

func (x *Model) GetType() string

func (*Model) GetUpdateTime

func (x *Model) GetUpdateTime() *timestamppb.Timestamp

func (*Model) ProtoMessage

func (*Model) ProtoMessage()

func (*Model) ProtoReflect

func (x *Model) ProtoReflect() protoreflect.Message

func (*Model) Reset

func (x *Model) Reset()

func (*Model) String

func (x *Model) String() string

ModelServiceClient

type ModelServiceClient interface {
	// Creates a new model.
	CreateModel(ctx context.Context, in *CreateModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Gets a model.
	GetModel(ctx context.Context, in *GetModelRequest, opts ...grpc.CallOption) (*Model, error)
	// Pauses the training of an existing model.
	PauseModel(ctx context.Context, in *PauseModelRequest, opts ...grpc.CallOption) (*Model, error)
	// Resumes the training of an existing model.
	ResumeModel(ctx context.Context, in *ResumeModelRequest, opts ...grpc.CallOption) (*Model, error)
	// Deletes an existing model.
	DeleteModel(ctx context.Context, in *DeleteModelRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists all the models linked to this event store.
	ListModels(ctx context.Context, in *ListModelsRequest, opts ...grpc.CallOption) (*ListModelsResponse, error)
	// 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.
	UpdateModel(ctx context.Context, in *UpdateModelRequest, opts ...grpc.CallOption) (*Model, error)
	// Tunes an existing model.
	TuneModel(ctx context.Context, in *TuneModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

ModelServiceClient is the client API for ModelService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewModelServiceClient

func NewModelServiceClient(cc grpc.ClientConnInterface) ModelServiceClient

ModelServiceServer

type ModelServiceServer interface {
	// Creates a new model.
	CreateModel(context.Context, *CreateModelRequest) (*longrunningpb.Operation, error)
	// Gets a model.
	GetModel(context.Context, *GetModelRequest) (*Model, error)
	// Pauses the training of an existing model.
	PauseModel(context.Context, *PauseModelRequest) (*Model, error)
	// Resumes the training of an existing model.
	ResumeModel(context.Context, *ResumeModelRequest) (*Model, error)
	// Deletes an existing model.
	DeleteModel(context.Context, *DeleteModelRequest) (*emptypb.Empty, error)
	// Lists all the models linked to this event store.
	ListModels(context.Context, *ListModelsRequest) (*ListModelsResponse, error)
	// 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.
	UpdateModel(context.Context, *UpdateModelRequest) (*Model, error)
	// Tunes an existing model.
	TuneModel(context.Context, *TuneModelRequest) (*longrunningpb.Operation, error)
}

ModelServiceServer is the server API for ModelService service.

Model_DataState

type Model_DataState int32

Describes whether this model have sufficient training data to be continuously trained.

Model_DATA_STATE_UNSPECIFIED, Model_DATA_OK, Model_DATA_ERROR

const (
	// Unspecified default value, should never be explicitly set.
	Model_DATA_STATE_UNSPECIFIED Model_DataState = 0
	// The model has sufficient training data.
	Model_DATA_OK Model_DataState = 1
	// The model does not have sufficient training data. Error
	// messages can be queried via Stackdriver.
	Model_DATA_ERROR Model_DataState = 2
)

func (Model_DataState) Descriptor

func (Model_DataState) Descriptor() protoreflect.EnumDescriptor

func (Model_DataState) Enum

func (x Model_DataState) Enum() *Model_DataState

func (Model_DataState) EnumDescriptor

func (Model_DataState) EnumDescriptor() ([]byte, []int)

Deprecated: Use Model_DataState.Descriptor instead.

func (Model_DataState) Number

func (x Model_DataState) Number() protoreflect.EnumNumber

func (Model_DataState) String

func (x Model_DataState) String() string

func (Model_DataState) Type

func (Model_DataState) Type() protoreflect.EnumType

Model_PeriodicTuningState

type Model_PeriodicTuningState int32

Describes whether periodic tuning is enabled for this model or not. Periodic tuning is scheduled at most every three months. You can start a tuning process manually by using the TuneModel method, which starts a tuning process immediately and resets the quarterly schedule. Enabling or disabling periodic tuning does not affect any current tuning processes.

Model_PERIODIC_TUNING_STATE_UNSPECIFIED, Model_PERIODIC_TUNING_DISABLED, Model_ALL_TUNING_DISABLED, Model_PERIODIC_TUNING_ENABLED

const (
	// Unspecified default value, should never be explicitly set.
	Model_PERIODIC_TUNING_STATE_UNSPECIFIED Model_PeriodicTuningState = 0
	// The model has periodic tuning disabled. Tuning
	// can be reenabled by calling the `EnableModelPeriodicTuning`
	// method or by calling the `TuneModel` method.
	Model_PERIODIC_TUNING_DISABLED Model_PeriodicTuningState = 1
	// The model cannot be tuned with periodic tuning OR the
	// `TuneModel` method. Hide the options in customer UI and
	// reject any requests through the backend self serve API.
	Model_ALL_TUNING_DISABLED Model_PeriodicTuningState = 3
	// The model has periodic tuning enabled. Tuning
	// can be disabled by calling the `DisableModelPeriodicTuning`
	// method.
	Model_PERIODIC_TUNING_ENABLED Model_PeriodicTuningState = 2
)

func (Model_PeriodicTuningState) Descriptor

func (Model_PeriodicTuningState) Descriptor() protoreflect.EnumDescriptor

func (Model_PeriodicTuningState) Enum

func (x Model_PeriodicTuningState) Enum() *Model_PeriodicTuningState

func (Model_PeriodicTuningState) EnumDescriptor

func (Model_PeriodicTuningState) EnumDescriptor() ([]byte, []int)

Deprecated: Use Model_PeriodicTuningState.Descriptor instead.

func (Model_PeriodicTuningState) Number

func (x Model_PeriodicTuningState) Number() protoreflect.EnumNumber

func (Model_PeriodicTuningState) String

func (x Model_PeriodicTuningState) String() string

func (Model_PeriodicTuningState) Type

func (Model_PeriodicTuningState) Type() protoreflect.EnumType

Model_ServingConfigList

type Model_ServingConfigList struct {

	// Optional. A set of valid serving configs that may be used for
	// `PAGE_OPTIMIZATION`.
	ServingConfigIds []string `protobuf:"bytes,1,rep,name=serving_config_ids,json=servingConfigIds,proto3" json:"serving_config_ids,omitempty"`
	// contains filtered or unexported fields
}

Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.

func (*Model_ServingConfigList) Descriptor

func (*Model_ServingConfigList) Descriptor() ([]byte, []int)

Deprecated: Use Model_ServingConfigList.ProtoReflect.Descriptor instead.

func (*Model_ServingConfigList) GetServingConfigIds

func (x *Model_ServingConfigList) GetServingConfigIds() []string

func (*Model_ServingConfigList) ProtoMessage

func (*Model_ServingConfigList) ProtoMessage()

func (*Model_ServingConfigList) ProtoReflect

func (x *Model_ServingConfigList) ProtoReflect() protoreflect.Message

func (*Model_ServingConfigList) Reset

func (x *Model_ServingConfigList) Reset()

func (*Model_ServingConfigList) String

func (x *Model_ServingConfigList) String() string

Model_ServingState

type Model_ServingState int32

The serving state of the model.

Model_SERVING_STATE_UNSPECIFIED, Model_INACTIVE, Model_ACTIVE, Model_TUNED

const (
	// Unspecified serving state.
	Model_SERVING_STATE_UNSPECIFIED Model_ServingState = 0
	// The model is not serving.
	Model_INACTIVE Model_ServingState = 1
	// The model is serving and can be queried.
	Model_ACTIVE Model_ServingState = 2
	// The model is trained on tuned hyperparameters and can be
	// queried.
	Model_TUNED Model_ServingState = 3
)

func (Model_ServingState) Descriptor

func (Model_ServingState) Descriptor() protoreflect.EnumDescriptor

func (Model_ServingState) Enum

func (x Model_ServingState) Enum() *Model_ServingState

func (Model_ServingState) EnumDescriptor

func (Model_ServingState) EnumDescriptor() ([]byte, []int)

Deprecated: Use Model_ServingState.Descriptor instead.

func (Model_ServingState) Number

func (x Model_ServingState) Number() protoreflect.EnumNumber

func (Model_ServingState) String

func (x Model_ServingState) String() string

func (Model_ServingState) Type

func (Model_ServingState) Type() protoreflect.EnumType

Model_TrainingState

type Model_TrainingState int32

The training state of the model.

Model_TRAINING_STATE_UNSPECIFIED, Model_PAUSED, Model_TRAINING

const (
	// Unspecified training state.
	Model_TRAINING_STATE_UNSPECIFIED Model_TrainingState = 0
	// The model training is paused.
	Model_PAUSED Model_TrainingState = 1
	// The model is training.
	Model_TRAINING Model_TrainingState = 2
)

func (Model_TrainingState) Descriptor

func (Model_TrainingState) Descriptor() protoreflect.EnumDescriptor

func (Model_TrainingState) Enum

func (x Model_TrainingState) Enum() *Model_TrainingState

func (Model_TrainingState) EnumDescriptor

func (Model_TrainingState) EnumDescriptor() ([]byte, []int)

Deprecated: Use Model_TrainingState.Descriptor instead.

func (Model_TrainingState) Number

func (x Model_TrainingState) Number() protoreflect.EnumNumber

func (Model_TrainingState) String

func (x Model_TrainingState) String() string

func (Model_TrainingState) Type

func (Model_TrainingState) Type() protoreflect.EnumType

OutputConfig

type OutputConfig struct {

	// The configuration of destination for holding output data.
	//
	// Types that are assignable to Destination:
	//
	//	*OutputConfig_GcsDestination_
	//	*OutputConfig_BigqueryDestination
	Destination isOutputConfig_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

The output configuration setting.

func (*OutputConfig) Descriptor

func (*OutputConfig) Descriptor() ([]byte, []int)

Deprecated: Use OutputConfig.ProtoReflect.Descriptor instead.

func (*OutputConfig) GetBigqueryDestination

func (x *OutputConfig) GetBigqueryDestination() *OutputConfig_BigQueryDestination

func (*OutputConfig) GetDestination

func (m *OutputConfig) GetDestination() isOutputConfig_Destination

func (*OutputConfig) GetGcsDestination

func (x *OutputConfig) GetGcsDestination() *OutputConfig_GcsDestination

func (*OutputConfig) ProtoMessage

func (*OutputConfig) ProtoMessage()

func (*OutputConfig) ProtoReflect

func (x *OutputConfig) ProtoReflect() protoreflect.Message

func (*OutputConfig) Reset

func (x *OutputConfig) Reset()

func (*OutputConfig) String

func (x *OutputConfig) String() string

OutputConfig_BigQueryDestination

type OutputConfig_BigQueryDestination struct {

	// Required. The ID of a BigQuery Dataset.
	DatasetId string `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// Required. The prefix of exported BigQuery tables.
	TableIdPrefix string `protobuf:"bytes,2,opt,name=table_id_prefix,json=tableIdPrefix,proto3" json:"table_id_prefix,omitempty"`
	// Required. Describes the table type. The following values are supported:
	//
	// * `table`: A BigQuery native table.
	// * `view`: A virtual table defined by a SQL query.
	TableType string `protobuf:"bytes,3,opt,name=table_type,json=tableType,proto3" json:"table_type,omitempty"`
	// contains filtered or unexported fields
}

The BigQuery output destination configuration.

func (*OutputConfig_BigQueryDestination) Descriptor

func (*OutputConfig_BigQueryDestination) Descriptor() ([]byte, []int)

Deprecated: Use OutputConfig_BigQueryDestination.ProtoReflect.Descriptor instead.

func (*OutputConfig_BigQueryDestination) GetDatasetId

func (x *OutputConfig_BigQueryDestination) GetDatasetId() string

func (*OutputConfig_BigQueryDestination) GetTableIdPrefix

func (x *OutputConfig_BigQueryDestination) GetTableIdPrefix() string

func (*OutputConfig_BigQueryDestination) GetTableType

func (x *OutputConfig_BigQueryDestination) GetTableType() string

func (*OutputConfig_BigQueryDestination) ProtoMessage

func (*OutputConfig_BigQueryDestination) ProtoMessage()

func (*OutputConfig_BigQueryDestination) ProtoReflect

func (x *OutputConfig_BigQueryDestination) ProtoReflect() protoreflect.Message

func (*OutputConfig_BigQueryDestination) Reset

func (x *OutputConfig_BigQueryDestination) Reset()

func (*OutputConfig_BigQueryDestination) String

func (x *OutputConfig_BigQueryDestination) String() string

OutputConfig_BigqueryDestination

type OutputConfig_BigqueryDestination struct {
	// The BigQuery location where the output is to be written to.
	BigqueryDestination *OutputConfig_BigQueryDestination `protobuf:"bytes,2,opt,name=bigquery_destination,json=bigqueryDestination,proto3,oneof"`
}

OutputConfig_GcsDestination

type OutputConfig_GcsDestination struct {

	// Required. The output uri prefix for saving output data to json files.
	// Some mapping examples are as follows:
	// output_uri_prefix         sample output(assuming the object is foo.json)
	// ========================  =============================================
	// gs://bucket/              gs://bucket/foo.json
	// gs://bucket/folder/       gs://bucket/folder/foo.json
	// gs://bucket/folder/item_  gs://bucket/folder/item_foo.json
	OutputUriPrefix string `protobuf:"bytes,1,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"`
	// contains filtered or unexported fields
}

The Google Cloud Storage output destination configuration.

func (*OutputConfig_GcsDestination) Descriptor

func (*OutputConfig_GcsDestination) Descriptor() ([]byte, []int)

Deprecated: Use OutputConfig_GcsDestination.ProtoReflect.Descriptor instead.

func (*OutputConfig_GcsDestination) GetOutputUriPrefix

func (x *OutputConfig_GcsDestination) GetOutputUriPrefix() string

func (*OutputConfig_GcsDestination) ProtoMessage

func (*OutputConfig_GcsDestination) ProtoMessage()

func (*OutputConfig_GcsDestination) ProtoReflect

func (x *OutputConfig_GcsDestination) ProtoReflect() protoreflect.Message

func (*OutputConfig_GcsDestination) Reset

func (x *OutputConfig_GcsDestination) Reset()

func (*OutputConfig_GcsDestination) String

func (x *OutputConfig_GcsDestination) String() string

OutputConfig_GcsDestination_

type OutputConfig_GcsDestination_ struct {
	// The Google Cloud Storage location where the output is to be written to.
	GcsDestination *OutputConfig_GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}

OutputResult

type OutputResult struct {

	// The BigQuery location where the result is stored.
	BigqueryResult []*BigQueryOutputResult `protobuf:"bytes,1,rep,name=bigquery_result,json=bigqueryResult,proto3" json:"bigquery_result,omitempty"`
	// The Google Cloud Storage location where the result is stored.
	GcsResult []*GcsOutputResult `protobuf:"bytes,2,rep,name=gcs_result,json=gcsResult,proto3" json:"gcs_result,omitempty"`
	// contains filtered or unexported fields
}

Output result that stores the information about where the exported data is stored.

func (*OutputResult) Descriptor

func (*OutputResult) Descriptor() ([]byte, []int)

Deprecated: Use OutputResult.ProtoReflect.Descriptor instead.

func (*OutputResult) GetBigqueryResult

func (x *OutputResult) GetBigqueryResult() []*BigQueryOutputResult

func (*OutputResult) GetGcsResult

func (x *OutputResult) GetGcsResult() []*GcsOutputResult

func (*OutputResult) ProtoMessage

func (*OutputResult) ProtoMessage()

func (*OutputResult) ProtoReflect

func (x *OutputResult) ProtoReflect() protoreflect.Message

func (*OutputResult) Reset

func (x *OutputResult) Reset()

func (*OutputResult) String

func (x *OutputResult) String() string

PauseModelRequest

type PauseModelRequest struct {

	// Required. The name of the model to pause.
	// Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for pausing training of a model.

func (*PauseModelRequest) Descriptor

func (*PauseModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use PauseModelRequest.ProtoReflect.Descriptor instead.

func (*PauseModelRequest) GetName

func (x *PauseModelRequest) GetName() string

func (*PauseModelRequest) ProtoMessage

func (*PauseModelRequest) ProtoMessage()

func (*PauseModelRequest) ProtoReflect

func (x *PauseModelRequest) ProtoReflect() protoreflect.Message

func (*PauseModelRequest) Reset

func (x *PauseModelRequest) Reset()

func (*PauseModelRequest) String

func (x *PauseModelRequest) String() string

PredictRequest

type PredictRequest struct {
	Placement string `protobuf:"bytes,1,opt,name=placement,proto3" json:"placement,omitempty"`

	UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`

	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`

	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`

	Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`

	ValidateOnly bool `protobuf:"varint,6,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`

	Params map[string]*structpb.Value "" /* 153 byte string literal not displayed */

	Labels map[string]string "" /* 153 byte string literal not displayed */

}

Request message for Predict method.

func (*PredictRequest) Descriptor

func (*PredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use PredictRequest.ProtoReflect.Descriptor instead.

func (*PredictRequest) GetFilter

func (x *PredictRequest) GetFilter() string

func (*PredictRequest) GetLabels

func (x *PredictRequest) GetLabels() map[string]string

func (*PredictRequest) GetPageSize

func (x *PredictRequest) GetPageSize() int32

func (*PredictRequest) GetPageToken

func (x *PredictRequest) GetPageToken() string

Deprecated: Marked as deprecated in google/cloud/retail/v2beta/prediction_service.proto.

func (*PredictRequest) GetParams

func (x *PredictRequest) GetParams() map[string]*structpb.Value

func (*PredictRequest) GetPlacement

func (x *PredictRequest) GetPlacement() string

func (*PredictRequest) GetUserEvent

func (x *PredictRequest) GetUserEvent() *UserEvent

func (*PredictRequest) GetValidateOnly

func (x *PredictRequest) GetValidateOnly() bool

func (*PredictRequest) ProtoMessage

func (*PredictRequest) ProtoMessage()

func (*PredictRequest) ProtoReflect

func (x *PredictRequest) ProtoReflect() protoreflect.Message

func (*PredictRequest) Reset

func (x *PredictRequest) Reset()

func (*PredictRequest) String

func (x *PredictRequest) String() string

PredictResponse

type PredictResponse struct {

	// A list of recommended products. The order represents the ranking (from the
	// most relevant product to the least).
	Results []*PredictResponse_PredictionResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// A unique attribution token. This should be included in the
	// [UserEvent][google.cloud.retail.v2beta.UserEvent] logs resulting from this
	// recommendation, which enables accurate attribution of recommendation model
	// performance.
	AttributionToken string `protobuf:"bytes,2,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
	// IDs of products in the request that were missing from the inventory.
	MissingIds []string `protobuf:"bytes,3,rep,name=missing_ids,json=missingIds,proto3" json:"missing_ids,omitempty"`
	// True if the validateOnly property was set in the request.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Response message for predict method.

func (*PredictResponse) Descriptor

func (*PredictResponse) Descriptor() ([]byte, []int)

Deprecated: Use PredictResponse.ProtoReflect.Descriptor instead.

func (*PredictResponse) GetAttributionToken

func (x *PredictResponse) GetAttributionToken() string

func (*PredictResponse) GetMissingIds

func (x *PredictResponse) GetMissingIds() []string

func (*PredictResponse) GetResults

func (x *PredictResponse) GetResults() []*PredictResponse_PredictionResult

func (*PredictResponse) GetValidateOnly

func (x *PredictResponse) GetValidateOnly() bool

func (*PredictResponse) ProtoMessage

func (*PredictResponse) ProtoMessage()

func (*PredictResponse) ProtoReflect

func (x *PredictResponse) ProtoReflect() protoreflect.Message

func (*PredictResponse) Reset

func (x *PredictResponse) Reset()

func (*PredictResponse) String

func (x *PredictResponse) String() string

PredictResponse_PredictionResult

type PredictResponse_PredictionResult struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`

	Metadata map[string]*structpb.Value "" /* 157 byte string literal not displayed */

}

PredictionResult represents the recommendation prediction results.

func (*PredictResponse_PredictionResult) Descriptor

func (*PredictResponse_PredictionResult) Descriptor() ([]byte, []int)

Deprecated: Use PredictResponse_PredictionResult.ProtoReflect.Descriptor instead.

func (*PredictResponse_PredictionResult) GetId

func (x *PredictResponse_PredictionResult) GetId() string

func (*PredictResponse_PredictionResult) GetMetadata

func (x *PredictResponse_PredictionResult) GetMetadata() map[string]*structpb.Value

func (*PredictResponse_PredictionResult) ProtoMessage

func (*PredictResponse_PredictionResult) ProtoMessage()

func (*PredictResponse_PredictionResult) ProtoReflect

func (x *PredictResponse_PredictionResult) ProtoReflect() protoreflect.Message

func (*PredictResponse_PredictionResult) Reset

func (x *PredictResponse_PredictionResult) Reset()

func (*PredictResponse_PredictionResult) String

func (x *PredictResponse_PredictionResult) String() string

PredictionServiceClient

type PredictionServiceClient interface {
	// Makes a recommendation prediction.
	Predict(ctx context.Context, in *PredictRequest, opts ...grpc.CallOption) (*PredictResponse, error)
}

PredictionServiceClient is the client API for PredictionService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewPredictionServiceClient

func NewPredictionServiceClient(cc grpc.ClientConnInterface) PredictionServiceClient

PredictionServiceServer

type PredictionServiceServer interface {
	// Makes a recommendation prediction.
	Predict(context.Context, *PredictRequest) (*PredictResponse, error)
}

PredictionServiceServer is the server API for PredictionService service.

PriceInfo

type PriceInfo struct {

	// The 3-letter currency code defined in [ISO
	// 4217](https://www.iso.org/iso-4217-currency-codes.html).
	//
	// If this field is an unrecognizable currency code, an INVALID_ARGUMENT
	// error is returned.
	//
	// The [Product.Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2beta.Product]s with the same
	// [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id]
	// must share the same
	// [currency_code][google.cloud.retail.v2beta.PriceInfo.currency_code].
	// Otherwise, a FAILED_PRECONDITION error is returned.
	CurrencyCode string `protobuf:"bytes,1,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// Price of the product.
	//
	// Google Merchant Center property
	// [price](https://support.google.com/merchants/answer/6324371). Schema.org
	// property [Offer.price](https://schema.org/price).
	Price float32 `protobuf:"fixed32,2,opt,name=price,proto3" json:"price,omitempty"`
	// Price of the product without any discount. If zero, by default set to be
	// the [price][google.cloud.retail.v2beta.PriceInfo.price]. If set,
	// [original_price][google.cloud.retail.v2beta.PriceInfo.original_price]
	// should be greater than or equal to
	// [price][google.cloud.retail.v2beta.PriceInfo.price], otherwise an
	// INVALID_ARGUMENT error is thrown.
	OriginalPrice float32 `protobuf:"fixed32,3,opt,name=original_price,json=originalPrice,proto3" json:"original_price,omitempty"`
	// The costs associated with the sale of a particular product. Used for gross
	// profit reporting.
	//
	// * Profit = [price][google.cloud.retail.v2beta.PriceInfo.price] -
	// [cost][google.cloud.retail.v2beta.PriceInfo.cost]
	//
	// Google Merchant Center property
	// [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895).
	Cost float32 `protobuf:"fixed32,4,opt,name=cost,proto3" json:"cost,omitempty"`
	// The timestamp when the [price][google.cloud.retail.v2beta.PriceInfo.price]
	// starts to be effective. This can be set as a future timestamp, and the
	// [price][google.cloud.retail.v2beta.PriceInfo.price] is only used for search
	// after
	// [price_effective_time][google.cloud.retail.v2beta.PriceInfo.price_effective_time].
	// If so, the
	// [original_price][google.cloud.retail.v2beta.PriceInfo.original_price] must
	// be set and
	// [original_price][google.cloud.retail.v2beta.PriceInfo.original_price] is
	// used before
	// [price_effective_time][google.cloud.retail.v2beta.PriceInfo.price_effective_time].
	//
	// Do not set if [price][google.cloud.retail.v2beta.PriceInfo.price] is always
	// effective because it will cause additional latency during search.
	PriceEffectiveTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=price_effective_time,json=priceEffectiveTime,proto3" json:"price_effective_time,omitempty"`
	// The timestamp when the [price][google.cloud.retail.v2beta.PriceInfo.price]
	// stops to be effective. The
	// [price][google.cloud.retail.v2beta.PriceInfo.price] is used for search
	// before
	// [price_expire_time][google.cloud.retail.v2beta.PriceInfo.price_expire_time].
	// If this field is set, the
	// [original_price][google.cloud.retail.v2beta.PriceInfo.original_price] must
	// be set and
	// [original_price][google.cloud.retail.v2beta.PriceInfo.original_price] is
	// used after
	// [price_expire_time][google.cloud.retail.v2beta.PriceInfo.price_expire_time].
	//
	// Do not set if [price][google.cloud.retail.v2beta.PriceInfo.price] is always
	// effective because it will cause additional latency during search.
	PriceExpireTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=price_expire_time,json=priceExpireTime,proto3" json:"price_expire_time,omitempty"`
	// Output only. The price range of all the child
	// [Product.Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2beta.Product]s grouped together on the
	// [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2beta.Product]. Only populated for
	// [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2beta.Product]s.
	//
	// Note: This field is OUTPUT_ONLY for
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct].
	// Do not set this field in API requests.
	PriceRange *PriceInfo_PriceRange `protobuf:"bytes,7,opt,name=price_range,json=priceRange,proto3" json:"price_range,omitempty"`
	// contains filtered or unexported fields
}

The price information of a [Product][google.cloud.retail.v2beta.Product].

func (*PriceInfo) Descriptor

func (*PriceInfo) Descriptor() ([]byte, []int)

Deprecated: Use PriceInfo.ProtoReflect.Descriptor instead.

func (*PriceInfo) GetCost

func (x *PriceInfo) GetCost() float32

func (*PriceInfo) GetCurrencyCode

func (x *PriceInfo) GetCurrencyCode() string

func (*PriceInfo) GetOriginalPrice

func (x *PriceInfo) GetOriginalPrice() float32

func (*PriceInfo) GetPrice

func (x *PriceInfo) GetPrice() float32

func (*PriceInfo) GetPriceEffectiveTime

func (x *PriceInfo) GetPriceEffectiveTime() *timestamppb.Timestamp

func (*PriceInfo) GetPriceExpireTime

func (x *PriceInfo) GetPriceExpireTime() *timestamppb.Timestamp

func (*PriceInfo) GetPriceRange

func (x *PriceInfo) GetPriceRange() *PriceInfo_PriceRange

func (*PriceInfo) ProtoMessage

func (*PriceInfo) ProtoMessage()

func (*PriceInfo) ProtoReflect

func (x *PriceInfo) ProtoReflect() protoreflect.Message

func (*PriceInfo) Reset

func (x *PriceInfo) Reset()

func (*PriceInfo) String

func (x *PriceInfo) String() string

PriceInfo_PriceRange

type PriceInfo_PriceRange struct {

	// The inclusive
	// [Product.pricing_info.price][google.cloud.retail.v2beta.PriceInfo.price]
	// interval of all
	// [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2beta.Product] having the same
	// [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id].
	Price *Interval `protobuf:"bytes,1,opt,name=price,proto3" json:"price,omitempty"`
	// The inclusive
	// [Product.pricing_info.original_price][google.cloud.retail.v2beta.PriceInfo.original_price]
	// internal of all
	// [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2beta.Product] having the same
	// [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id].
	OriginalPrice *Interval `protobuf:"bytes,2,opt,name=original_price,json=originalPrice,proto3" json:"original_price,omitempty"`
	// contains filtered or unexported fields
}

The price range of all [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] having the same [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id].

func (*PriceInfo_PriceRange) Descriptor

func (*PriceInfo_PriceRange) Descriptor() ([]byte, []int)

Deprecated: Use PriceInfo_PriceRange.ProtoReflect.Descriptor instead.

func (*PriceInfo_PriceRange) GetOriginalPrice

func (x *PriceInfo_PriceRange) GetOriginalPrice() *Interval

func (*PriceInfo_PriceRange) GetPrice

func (x *PriceInfo_PriceRange) GetPrice() *Interval

func (*PriceInfo_PriceRange) ProtoMessage

func (*PriceInfo_PriceRange) ProtoMessage()

func (*PriceInfo_PriceRange) ProtoReflect

func (x *PriceInfo_PriceRange) ProtoReflect() protoreflect.Message

func (*PriceInfo_PriceRange) Reset

func (x *PriceInfo_PriceRange) Reset()

func (*PriceInfo_PriceRange) String

func (x *PriceInfo_PriceRange) String() string

Product

type Product struct {
	Expiration isProduct_Expiration `protobuf_oneof:"expiration"`

	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`

	Type Product_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.retail.v2beta.Product_Type" json:"type,omitempty"`

	PrimaryProductId string `protobuf:"bytes,4,opt,name=primary_product_id,json=primaryProductId,proto3" json:"primary_product_id,omitempty"`

	CollectionMemberIds []string `protobuf:"bytes,5,rep,name=collection_member_ids,json=collectionMemberIds,proto3" json:"collection_member_ids,omitempty"`

	Gtin string `protobuf:"bytes,6,opt,name=gtin,proto3" json:"gtin,omitempty"`

	Categories []string `protobuf:"bytes,7,rep,name=categories,proto3" json:"categories,omitempty"`

	Title string `protobuf:"bytes,8,opt,name=title,proto3" json:"title,omitempty"`

	Brands []string `protobuf:"bytes,9,rep,name=brands,proto3" json:"brands,omitempty"`

	Description string `protobuf:"bytes,10,opt,name=description,proto3" json:"description,omitempty"`

	LanguageCode string `protobuf:"bytes,11,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`

	Attributes map[string]*CustomAttribute "" /* 162 byte string literal not displayed */

	Tags []string `protobuf:"bytes,13,rep,name=tags,proto3" json:"tags,omitempty"`

	PriceInfo *PriceInfo `protobuf:"bytes,14,opt,name=price_info,json=priceInfo,proto3" json:"price_info,omitempty"`

	Rating *Rating `protobuf:"bytes,15,opt,name=rating,proto3" json:"rating,omitempty"`

	AvailableTime *timestamppb.Timestamp `protobuf:"bytes,18,opt,name=available_time,json=availableTime,proto3" json:"available_time,omitempty"`

	Availability Product_Availability "" /* 132 byte string literal not displayed */

	AvailableQuantity *wrapperspb.Int32Value `protobuf:"bytes,20,opt,name=available_quantity,json=availableQuantity,proto3" json:"available_quantity,omitempty"`

	FulfillmentInfo []*FulfillmentInfo `protobuf:"bytes,21,rep,name=fulfillment_info,json=fulfillmentInfo,proto3" json:"fulfillment_info,omitempty"`

	Uri string `protobuf:"bytes,22,opt,name=uri,proto3" json:"uri,omitempty"`

	Images []*Image `protobuf:"bytes,23,rep,name=images,proto3" json:"images,omitempty"`

	Audience *Audience `protobuf:"bytes,24,opt,name=audience,proto3" json:"audience,omitempty"`

	ColorInfo *ColorInfo `protobuf:"bytes,25,opt,name=color_info,json=colorInfo,proto3" json:"color_info,omitempty"`

	Sizes []string `protobuf:"bytes,26,rep,name=sizes,proto3" json:"sizes,omitempty"`

	Materials []string `protobuf:"bytes,27,rep,name=materials,proto3" json:"materials,omitempty"`

	Patterns []string `protobuf:"bytes,28,rep,name=patterns,proto3" json:"patterns,omitempty"`

	Conditions []string `protobuf:"bytes,29,rep,name=conditions,proto3" json:"conditions,omitempty"`

	Promotions []*Promotion `protobuf:"bytes,34,rep,name=promotions,proto3" json:"promotions,omitempty"`

	PublishTime *timestamppb.Timestamp `protobuf:"bytes,33,opt,name=publish_time,json=publishTime,proto3" json:"publish_time,omitempty"`

	RetrievableFields *fieldmaskpb.FieldMask `protobuf:"bytes,30,opt,name=retrievable_fields,json=retrievableFields,proto3" json:"retrievable_fields,omitempty"`

	Variants []*Product `protobuf:"bytes,31,rep,name=variants,proto3" json:"variants,omitempty"`

	LocalInventories []*LocalInventory `protobuf:"bytes,35,rep,name=local_inventories,json=localInventories,proto3" json:"local_inventories,omitempty"`

}

Product captures all metadata information of items to be recommended or searched.

func (*Product) Descriptor

func (*Product) Descriptor() ([]byte, []int)

Deprecated: Use Product.ProtoReflect.Descriptor instead.

func (*Product) GetAttributes

func (x *Product) GetAttributes() map[string]*CustomAttribute

func (*Product) GetAudience

func (x *Product) GetAudience() *Audience

func (*Product) GetAvailability

func (x *Product) GetAvailability() Product_Availability

func (*Product) GetAvailableQuantity

func (x *Product) GetAvailableQuantity() *wrapperspb.Int32Value

func (*Product) GetAvailableTime

func (x *Product) GetAvailableTime() *timestamppb.Timestamp

func (*Product) GetBrands

func (x *Product) GetBrands() []string

func (*Product) GetCategories

func (x *Product) GetCategories() []string

func (*Product) GetCollectionMemberIds

func (x *Product) GetCollectionMemberIds() []string

func (*Product) GetColorInfo

func (x *Product) GetColorInfo() *ColorInfo

func (*Product) GetConditions

func (x *Product) GetConditions() []string

func (*Product) GetDescription

func (x *Product) GetDescription() string

func (*Product) GetExpiration

func (m *Product) GetExpiration() isProduct_Expiration

func (*Product) GetExpireTime

func (x *Product) GetExpireTime() *timestamppb.Timestamp

func (*Product) GetFulfillmentInfo

func (x *Product) GetFulfillmentInfo() []*FulfillmentInfo

func (*Product) GetGtin

func (x *Product) GetGtin() string

func (*Product) GetId

func (x *Product) GetId() string

func (*Product) GetImages

func (x *Product) GetImages() []*Image

func (*Product) GetLanguageCode

func (x *Product) GetLanguageCode() string

func (*Product) GetLocalInventories

func (x *Product) GetLocalInventories() []*LocalInventory

func (*Product) GetMaterials

func (x *Product) GetMaterials() []string

func (*Product) GetName

func (x *Product) GetName() string

func (*Product) GetPatterns

func (x *Product) GetPatterns() []string

func (*Product) GetPriceInfo

func (x *Product) GetPriceInfo() *PriceInfo

func (*Product) GetPrimaryProductId

func (x *Product) GetPrimaryProductId() string

func (*Product) GetPromotions

func (x *Product) GetPromotions() []*Promotion

func (*Product) GetPublishTime

func (x *Product) GetPublishTime() *timestamppb.Timestamp

func (*Product) GetRating

func (x *Product) GetRating() *Rating

func (*Product) GetRetrievableFields

func (x *Product) GetRetrievableFields() *fieldmaskpb.FieldMask

Deprecated: Marked as deprecated in google/cloud/retail/v2beta/product.proto.

func (*Product) GetSizes

func (x *Product) GetSizes() []string

func (*Product) GetTags

func (x *Product) GetTags() []string

func (*Product) GetTitle

func (x *Product) GetTitle() string

func (*Product) GetTtl

func (x *Product) GetTtl() *durationpb.Duration

func (*Product) GetType

func (x *Product) GetType() Product_Type

func (*Product) GetUri

func (x *Product) GetUri() string

func (*Product) GetVariants

func (x *Product) GetVariants() []*Product

func (*Product) ProtoMessage

func (*Product) ProtoMessage()

func (*Product) ProtoReflect

func (x *Product) ProtoReflect() protoreflect.Message

func (*Product) Reset

func (x *Product) Reset()

func (*Product) String

func (x *Product) String() string

ProductDetail

type ProductDetail struct {

	// Required. [Product][google.cloud.retail.v2beta.Product] information.
	//
	// Required field(s):
	//
	// * [Product.id][google.cloud.retail.v2beta.Product.id]
	//
	// Optional override field(s):
	//
	// * [Product.price_info][google.cloud.retail.v2beta.Product.price_info]
	//
	// If any supported optional fields are provided, we will treat them as a full
	// override when looking up product information from the catalog. Thus, it is
	// important to ensure that the overriding fields are accurate and
	// complete.
	//
	// All other product fields are ignored and instead populated via catalog
	// lookup after event ingestion.
	Product *Product `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
	// Quantity of the product associated with the user event.
	//
	// For example, this field will be 2 if two products are added to the shopping
	// cart for `purchase-complete` event. Required for `add-to-cart` and
	// `purchase-complete` event types.
	Quantity *wrapperspb.Int32Value `protobuf:"bytes,2,opt,name=quantity,proto3" json:"quantity,omitempty"`
	// contains filtered or unexported fields
}

Detailed product information associated with a user event.

func (*ProductDetail) Descriptor

func (*ProductDetail) Descriptor() ([]byte, []int)

Deprecated: Use ProductDetail.ProtoReflect.Descriptor instead.

func (*ProductDetail) GetProduct

func (x *ProductDetail) GetProduct() *Product

func (*ProductDetail) GetQuantity

func (x *ProductDetail) GetQuantity() *wrapperspb.Int32Value

func (*ProductDetail) ProtoMessage

func (*ProductDetail) ProtoMessage()

func (*ProductDetail) ProtoReflect

func (x *ProductDetail) ProtoReflect() protoreflect.Message

func (*ProductDetail) Reset

func (x *ProductDetail) Reset()

func (*ProductDetail) String

func (x *ProductDetail) String() string

ProductInlineSource

type ProductInlineSource struct {

	// Required. A list of products to update/create. Each product must have a
	// valid [Product.id][google.cloud.retail.v2beta.Product.id]. Recommended max
	// of 100 items.
	Products []*Product `protobuf:"bytes,1,rep,name=products,proto3" json:"products,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for ImportProducts method.

func (*ProductInlineSource) Descriptor

func (*ProductInlineSource) Descriptor() ([]byte, []int)

Deprecated: Use ProductInlineSource.ProtoReflect.Descriptor instead.

func (*ProductInlineSource) GetProducts

func (x *ProductInlineSource) GetProducts() []*Product

func (*ProductInlineSource) ProtoMessage

func (*ProductInlineSource) ProtoMessage()

func (*ProductInlineSource) ProtoReflect

func (x *ProductInlineSource) ProtoReflect() protoreflect.Message

func (*ProductInlineSource) Reset

func (x *ProductInlineSource) Reset()

func (*ProductInlineSource) String

func (x *ProductInlineSource) String() string

ProductInputConfig

type ProductInputConfig struct {

	// Required. The source of the input.
	//
	// Types that are assignable to Source:
	//
	//	*ProductInputConfig_ProductInlineSource
	//	*ProductInputConfig_GcsSource
	//	*ProductInputConfig_BigQuerySource
	Source isProductInputConfig_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

The input config source for products.

func (*ProductInputConfig) Descriptor

func (*ProductInputConfig) Descriptor() ([]byte, []int)

Deprecated: Use ProductInputConfig.ProtoReflect.Descriptor instead.

func (*ProductInputConfig) GetBigQuerySource

func (x *ProductInputConfig) GetBigQuerySource() *BigQuerySource

func (*ProductInputConfig) GetGcsSource

func (x *ProductInputConfig) GetGcsSource() *GcsSource

func (*ProductInputConfig) GetProductInlineSource

func (x *ProductInputConfig) GetProductInlineSource() *ProductInlineSource

func (*ProductInputConfig) GetSource

func (m *ProductInputConfig) GetSource() isProductInputConfig_Source

func (*ProductInputConfig) ProtoMessage

func (*ProductInputConfig) ProtoMessage()

func (*ProductInputConfig) ProtoReflect

func (x *ProductInputConfig) ProtoReflect() protoreflect.Message

func (*ProductInputConfig) Reset

func (x *ProductInputConfig) Reset()

func (*ProductInputConfig) String

func (x *ProductInputConfig) String() string

ProductInputConfig_BigQuerySource

type ProductInputConfig_BigQuerySource struct {
	// BigQuery input source.
	BigQuerySource *BigQuerySource `protobuf:"bytes,3,opt,name=big_query_source,json=bigQuerySource,proto3,oneof"`
}

ProductInputConfig_GcsSource

type ProductInputConfig_GcsSource struct {
	// Google Cloud Storage location for the input content.
	GcsSource *GcsSource `protobuf:"bytes,2,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

ProductInputConfig_ProductInlineSource

type ProductInputConfig_ProductInlineSource struct {
	// The Inline source for the input content for products.
	ProductInlineSource *ProductInlineSource `protobuf:"bytes,1,opt,name=product_inline_source,json=productInlineSource,proto3,oneof"`
}

ProductLevelConfig

type ProductLevelConfig struct {
	IngestionProductType string `protobuf:"bytes,1,opt,name=ingestion_product_type,json=ingestionProductType,proto3" json:"ingestion_product_type,omitempty"`

	MerchantCenterProductIdField string "" /* 151 byte string literal not displayed */

}

Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.

func (*ProductLevelConfig) Descriptor

func (*ProductLevelConfig) Descriptor() ([]byte, []int)

Deprecated: Use ProductLevelConfig.ProtoReflect.Descriptor instead.

func (*ProductLevelConfig) GetIngestionProductType

func (x *ProductLevelConfig) GetIngestionProductType() string

func (*ProductLevelConfig) GetMerchantCenterProductIdField

func (x *ProductLevelConfig) GetMerchantCenterProductIdField() string

func (*ProductLevelConfig) ProtoMessage

func (*ProductLevelConfig) ProtoMessage()

func (*ProductLevelConfig) ProtoReflect

func (x *ProductLevelConfig) ProtoReflect() protoreflect.Message

func (*ProductLevelConfig) Reset

func (x *ProductLevelConfig) Reset()

func (*ProductLevelConfig) String

func (x *ProductLevelConfig) String() string

ProductServiceClient

type ProductServiceClient interface {
	// Creates a [Product][google.cloud.retail.v2beta.Product].
	CreateProduct(ctx context.Context, in *CreateProductRequest, opts ...grpc.CallOption) (*Product, error)
	// Gets a [Product][google.cloud.retail.v2beta.Product].
	GetProduct(ctx context.Context, in *GetProductRequest, opts ...grpc.CallOption) (*Product, error)
	// Gets a list of [Product][google.cloud.retail.v2beta.Product]s.
	ListProducts(ctx context.Context, in *ListProductsRequest, opts ...grpc.CallOption) (*ListProductsResponse, error)
	// Updates a [Product][google.cloud.retail.v2beta.Product].
	UpdateProduct(ctx context.Context, in *UpdateProductRequest, opts ...grpc.CallOption) (*Product, error)
	// Deletes a [Product][google.cloud.retail.v2beta.Product].
	DeleteProduct(ctx context.Context, in *DeleteProductRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Bulk import of multiple [Product][google.cloud.retail.v2beta.Product]s.
	//
	// Request processing may be synchronous.
	// Non-existing items are created.
	//
	// Note that it is possible for a subset of the
	// [Product][google.cloud.retail.v2beta.Product]s to be successfully updated.
	ImportProducts(ctx context.Context, in *ImportProductsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates inventory information for a
	// [Product][google.cloud.retail.v2beta.Product] while respecting the last
	// update timestamps of each inventory field.
	//
	// This process is asynchronous and does not require the
	// [Product][google.cloud.retail.v2beta.Product] to exist before updating
	// fulfillment information. If the request is valid, the update is enqueued
	// and processed downstream. As a consequence, when a response is returned,
	// updates are not immediately manifested in the
	// [Product][google.cloud.retail.v2beta.Product] queried by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// or
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// When inventory is updated with
	// [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
	// and
	// [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct],
	// the specified inventory field value(s) overwrite any existing value(s)
	// while ignoring the last update time for this field. Furthermore, the last
	// update times for the specified inventory fields are overwritten by the
	// times of the
	// [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
	// or
	// [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct]
	// request.
	//
	// If no inventory fields are set in
	// [CreateProductRequest.product][google.cloud.retail.v2beta.CreateProductRequest.product],
	// then any pre-existing inventory information for this product is used.
	//
	// If no inventory fields are set in
	// [SetInventoryRequest.set_mask][google.cloud.retail.v2beta.SetInventoryRequest.set_mask],
	// then any existing inventory information is preserved.
	//
	// Pre-existing inventory information can only be updated with
	// [ProductService.SetInventory][google.cloud.retail.v2beta.ProductService.SetInventory],
	// [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces],
	// and
	// [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces].
	//
	// The returned [Operation][google.longrunning.Operation]s is obsolete after
	// one day, and the [GetOperation][google.longrunning.Operations.GetOperation]
	// API returns `NOT_FOUND` afterwards.
	//
	// If conflicting updates are issued, the
	// [Operation][google.longrunning.Operation]s associated with the stale
	// updates are not marked as [done][google.longrunning.Operation.done] until
	// they are obsolete.
	SetInventory(ctx context.Context, in *SetInventoryRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// It is recommended to use the
	// [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories]
	// method instead of
	// [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces].
	// [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories]
	// achieves the same results but provides more fine-grained control over
	// ingesting local inventory data.
	//
	// Incrementally adds place IDs to
	// [Product.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids].
	//
	// This process is asynchronous and does not require the
	// [Product][google.cloud.retail.v2beta.Product] to exist before updating
	// fulfillment information. If the request is valid, the update will be
	// enqueued and processed downstream. As a consequence, when a response is
	// returned, the added place IDs are not immediately manifested in the
	// [Product][google.cloud.retail.v2beta.Product] queried by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// or
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// The returned [Operation][google.longrunning.Operation]s will be obsolete
	// after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
	// API will return NOT_FOUND afterwards.
	//
	// If conflicting updates are issued, the
	// [Operation][google.longrunning.Operation]s associated with the stale
	// updates will not be marked as [done][google.longrunning.Operation.done]
	// until being obsolete.
	AddFulfillmentPlaces(ctx context.Context, in *AddFulfillmentPlacesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// It is recommended to use the
	// [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories]
	// method instead of
	// [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces].
	// [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories]
	// achieves the same results but provides more fine-grained control over
	// ingesting local inventory data.
	//
	// Incrementally removes place IDs from a
	// [Product.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids].
	//
	// This process is asynchronous and does not require the
	// [Product][google.cloud.retail.v2beta.Product] to exist before updating
	// fulfillment information. If the request is valid, the update will be
	// enqueued and processed downstream. As a consequence, when a response is
	// returned, the removed place IDs are not immediately manifested in the
	// [Product][google.cloud.retail.v2beta.Product] queried by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// or
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// The returned [Operation][google.longrunning.Operation]s will be obsolete
	// after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
	// API will return NOT_FOUND afterwards.
	//
	// If conflicting updates are issued, the
	// [Operation][google.longrunning.Operation]s associated with the stale
	// updates will not be marked as [done][google.longrunning.Operation.done]
	// until being obsolete.
	RemoveFulfillmentPlaces(ctx context.Context, in *RemoveFulfillmentPlacesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates local inventory information for a
	// [Product][google.cloud.retail.v2beta.Product] at a list of places, while
	// respecting the last update timestamps of each inventory field.
	//
	// This process is asynchronous and does not require the
	// [Product][google.cloud.retail.v2beta.Product] to exist before updating
	// inventory information. If the request is valid, the update will be enqueued
	// and processed downstream. As a consequence, when a response is returned,
	// updates are not immediately manifested in the
	// [Product][google.cloud.retail.v2beta.Product] queried by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// or
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// Local inventory information can only be modified using this method.
	// [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
	// and
	// [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct]
	// has no effect on local inventories.
	//
	// The returned [Operation][google.longrunning.Operation]s will be obsolete
	// after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
	// API will return NOT_FOUND afterwards.
	//
	// If conflicting updates are issued, the
	// [Operation][google.longrunning.Operation]s associated with the stale
	// updates will not be marked as [done][google.longrunning.Operation.done]
	// until being obsolete.
	AddLocalInventories(ctx context.Context, in *AddLocalInventoriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Remove local inventory information for a
	// [Product][google.cloud.retail.v2beta.Product] at a list of places at a
	// removal timestamp.
	//
	// This process is asynchronous. If the request is valid, the removal will be
	// enqueued and processed downstream. As a consequence, when a response is
	// returned, removals are not immediately manifested in the
	// [Product][google.cloud.retail.v2beta.Product] queried by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// or
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// Local inventory information can only be removed using this method.
	// [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
	// and
	// [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct]
	// has no effect on local inventories.
	//
	// The returned [Operation][google.longrunning.Operation]s will be obsolete
	// after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
	// API will return NOT_FOUND afterwards.
	//
	// If conflicting updates are issued, the
	// [Operation][google.longrunning.Operation]s associated with the stale
	// updates will not be marked as [done][google.longrunning.Operation.done]
	// until being obsolete.
	RemoveLocalInventories(ctx context.Context, in *RemoveLocalInventoriesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

ProductServiceClient is the client API for ProductService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewProductServiceClient

func NewProductServiceClient(cc grpc.ClientConnInterface) ProductServiceClient

ProductServiceServer

type ProductServiceServer interface {
	// Creates a [Product][google.cloud.retail.v2beta.Product].
	CreateProduct(context.Context, *CreateProductRequest) (*Product, error)
	// Gets a [Product][google.cloud.retail.v2beta.Product].
	GetProduct(context.Context, *GetProductRequest) (*Product, error)
	// Gets a list of [Product][google.cloud.retail.v2beta.Product]s.
	ListProducts(context.Context, *ListProductsRequest) (*ListProductsResponse, error)
	// Updates a [Product][google.cloud.retail.v2beta.Product].
	UpdateProduct(context.Context, *UpdateProductRequest) (*Product, error)
	// Deletes a [Product][google.cloud.retail.v2beta.Product].
	DeleteProduct(context.Context, *DeleteProductRequest) (*emptypb.Empty, error)
	// Bulk import of multiple [Product][google.cloud.retail.v2beta.Product]s.
	//
	// Request processing may be synchronous.
	// Non-existing items are created.
	//
	// Note that it is possible for a subset of the
	// [Product][google.cloud.retail.v2beta.Product]s to be successfully updated.
	ImportProducts(context.Context, *ImportProductsRequest) (*longrunningpb.Operation, error)
	// Updates inventory information for a
	// [Product][google.cloud.retail.v2beta.Product] while respecting the last
	// update timestamps of each inventory field.
	//
	// This process is asynchronous and does not require the
	// [Product][google.cloud.retail.v2beta.Product] to exist before updating
	// fulfillment information. If the request is valid, the update is enqueued
	// and processed downstream. As a consequence, when a response is returned,
	// updates are not immediately manifested in the
	// [Product][google.cloud.retail.v2beta.Product] queried by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// or
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// When inventory is updated with
	// [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
	// and
	// [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct],
	// the specified inventory field value(s) overwrite any existing value(s)
	// while ignoring the last update time for this field. Furthermore, the last
	// update times for the specified inventory fields are overwritten by the
	// times of the
	// [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
	// or
	// [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct]
	// request.
	//
	// If no inventory fields are set in
	// [CreateProductRequest.product][google.cloud.retail.v2beta.CreateProductRequest.product],
	// then any pre-existing inventory information for this product is used.
	//
	// If no inventory fields are set in
	// [SetInventoryRequest.set_mask][google.cloud.retail.v2beta.SetInventoryRequest.set_mask],
	// then any existing inventory information is preserved.
	//
	// Pre-existing inventory information can only be updated with
	// [ProductService.SetInventory][google.cloud.retail.v2beta.ProductService.SetInventory],
	// [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces],
	// and
	// [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces].
	//
	// The returned [Operation][google.longrunning.Operation]s is obsolete after
	// one day, and the [GetOperation][google.longrunning.Operations.GetOperation]
	// API returns `NOT_FOUND` afterwards.
	//
	// If conflicting updates are issued, the
	// [Operation][google.longrunning.Operation]s associated with the stale
	// updates are not marked as [done][google.longrunning.Operation.done] until
	// they are obsolete.
	SetInventory(context.Context, *SetInventoryRequest) (*longrunningpb.Operation, error)
	// It is recommended to use the
	// [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories]
	// method instead of
	// [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces].
	// [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories]
	// achieves the same results but provides more fine-grained control over
	// ingesting local inventory data.
	//
	// Incrementally adds place IDs to
	// [Product.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids].
	//
	// This process is asynchronous and does not require the
	// [Product][google.cloud.retail.v2beta.Product] to exist before updating
	// fulfillment information. If the request is valid, the update will be
	// enqueued and processed downstream. As a consequence, when a response is
	// returned, the added place IDs are not immediately manifested in the
	// [Product][google.cloud.retail.v2beta.Product] queried by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// or
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// The returned [Operation][google.longrunning.Operation]s will be obsolete
	// after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
	// API will return NOT_FOUND afterwards.
	//
	// If conflicting updates are issued, the
	// [Operation][google.longrunning.Operation]s associated with the stale
	// updates will not be marked as [done][google.longrunning.Operation.done]
	// until being obsolete.
	AddFulfillmentPlaces(context.Context, *AddFulfillmentPlacesRequest) (*longrunningpb.Operation, error)
	// It is recommended to use the
	// [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories]
	// method instead of
	// [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces].
	// [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories]
	// achieves the same results but provides more fine-grained control over
	// ingesting local inventory data.
	//
	// Incrementally removes place IDs from a
	// [Product.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids].
	//
	// This process is asynchronous and does not require the
	// [Product][google.cloud.retail.v2beta.Product] to exist before updating
	// fulfillment information. If the request is valid, the update will be
	// enqueued and processed downstream. As a consequence, when a response is
	// returned, the removed place IDs are not immediately manifested in the
	// [Product][google.cloud.retail.v2beta.Product] queried by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// or
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// The returned [Operation][google.longrunning.Operation]s will be obsolete
	// after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
	// API will return NOT_FOUND afterwards.
	//
	// If conflicting updates are issued, the
	// [Operation][google.longrunning.Operation]s associated with the stale
	// updates will not be marked as [done][google.longrunning.Operation.done]
	// until being obsolete.
	RemoveFulfillmentPlaces(context.Context, *RemoveFulfillmentPlacesRequest) (*longrunningpb.Operation, error)
	// Updates local inventory information for a
	// [Product][google.cloud.retail.v2beta.Product] at a list of places, while
	// respecting the last update timestamps of each inventory field.
	//
	// This process is asynchronous and does not require the
	// [Product][google.cloud.retail.v2beta.Product] to exist before updating
	// inventory information. If the request is valid, the update will be enqueued
	// and processed downstream. As a consequence, when a response is returned,
	// updates are not immediately manifested in the
	// [Product][google.cloud.retail.v2beta.Product] queried by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// or
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// Local inventory information can only be modified using this method.
	// [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
	// and
	// [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct]
	// has no effect on local inventories.
	//
	// The returned [Operation][google.longrunning.Operation]s will be obsolete
	// after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
	// API will return NOT_FOUND afterwards.
	//
	// If conflicting updates are issued, the
	// [Operation][google.longrunning.Operation]s associated with the stale
	// updates will not be marked as [done][google.longrunning.Operation.done]
	// until being obsolete.
	AddLocalInventories(context.Context, *AddLocalInventoriesRequest) (*longrunningpb.Operation, error)
	// Remove local inventory information for a
	// [Product][google.cloud.retail.v2beta.Product] at a list of places at a
	// removal timestamp.
	//
	// This process is asynchronous. If the request is valid, the removal will be
	// enqueued and processed downstream. As a consequence, when a response is
	// returned, removals are not immediately manifested in the
	// [Product][google.cloud.retail.v2beta.Product] queried by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// or
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// Local inventory information can only be removed using this method.
	// [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
	// and
	// [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct]
	// has no effect on local inventories.
	//
	// The returned [Operation][google.longrunning.Operation]s will be obsolete
	// after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
	// API will return NOT_FOUND afterwards.
	//
	// If conflicting updates are issued, the
	// [Operation][google.longrunning.Operation]s associated with the stale
	// updates will not be marked as [done][google.longrunning.Operation.done]
	// until being obsolete.
	RemoveLocalInventories(context.Context, *RemoveLocalInventoriesRequest) (*longrunningpb.Operation, error)
}

ProductServiceServer is the server API for ProductService service.

Product_Availability

type Product_Availability int32

Product availability. If this field is unspecified, the product is assumed to be in stock.

Product_AVAILABILITY_UNSPECIFIED, Product_IN_STOCK, Product_OUT_OF_STOCK, Product_PREORDER, Product_BACKORDER

const (
	// Default product availability. Default to
	// [Availability.IN_STOCK][google.cloud.retail.v2beta.Product.Availability.IN_STOCK]
	// if unset.
	Product_AVAILABILITY_UNSPECIFIED Product_Availability = 0
	// Product in stock.
	Product_IN_STOCK Product_Availability = 1
	// Product out of stock.
	Product_OUT_OF_STOCK Product_Availability = 2
	// Product that is in pre-order state.
	Product_PREORDER Product_Availability = 3
	// Product that is back-ordered (i.e. temporarily out of stock).
	Product_BACKORDER Product_Availability = 4
)

func (Product_Availability) Descriptor

func (Product_Availability) Descriptor() protoreflect.EnumDescriptor

func (Product_Availability) Enum

func (x Product_Availability) Enum() *Product_Availability

func (Product_Availability) EnumDescriptor

func (Product_Availability) EnumDescriptor() ([]byte, []int)

Deprecated: Use Product_Availability.Descriptor instead.

func (Product_Availability) Number

func (x Product_Availability) Number() protoreflect.EnumNumber

func (Product_Availability) String

func (x Product_Availability) String() string

func (Product_Availability) Type

func (Product_Availability) Type() protoreflect.EnumType

Product_ExpireTime

type Product_ExpireTime struct {
	// The timestamp when this product becomes unavailable for
	// [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].
	// Note that this is only applicable to
	// [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and
	// [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION],
	// and ignored for
	// [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]. In
	// general, we suggest the users to delete the stale products explicitly,
	// instead of using this field to determine staleness.
	//
	// If it is set, the [Product][google.cloud.retail.v2beta.Product] is not
	// available for
	// [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]
	// after [expire_time][google.cloud.retail.v2beta.Product.expire_time].
	// However, the product can still be retrieved by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// and
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	//
	// [expire_time][google.cloud.retail.v2beta.Product.expire_time] must be
	// later than
	// [available_time][google.cloud.retail.v2beta.Product.available_time] and
	// [publish_time][google.cloud.retail.v2beta.Product.publish_time],
	// otherwise an INVALID_ARGUMENT error is thrown.
	//
	// Corresponding properties: Google Merchant Center property
	// [expiration_date](https://support.google.com/merchants/answer/6324499).
	ExpireTime *timestamppb.Timestamp `protobuf:"bytes,16,opt,name=expire_time,json=expireTime,proto3,oneof"`
}

Product_Ttl

type Product_Ttl struct {
	// Input only. The TTL (time to live) of the product. Note that this is only
	// applicable to
	// [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY] and
	// [Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION],
	// and ignored for
	// [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]. In
	// general, we suggest the users to delete the stale products explicitly,
	// instead of using this field to determine staleness.
	//
	// If it is set, it must be a non-negative value, and
	// [expire_time][google.cloud.retail.v2beta.Product.expire_time] is set as
	// current timestamp plus [ttl][google.cloud.retail.v2beta.Product.ttl]. The
	// derived [expire_time][google.cloud.retail.v2beta.Product.expire_time] is
	// returned in the output and [ttl][google.cloud.retail.v2beta.Product.ttl]
	// is left blank when retrieving the
	// [Product][google.cloud.retail.v2beta.Product].
	//
	// If it is set, the product is not available for
	// [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]
	// after current timestamp plus
	// [ttl][google.cloud.retail.v2beta.Product.ttl]. However, the product can
	// still be retrieved by
	// [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
	// and
	// [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
	Ttl *durationpb.Duration `protobuf:"bytes,17,opt,name=ttl,proto3,oneof"`
}

Product_Type

type Product_Type int32

The type of this product.

Product_TYPE_UNSPECIFIED, Product_PRIMARY, Product_VARIANT, Product_COLLECTION

const (
	// Default value. Default to
	// [Catalog.product_level_config.ingestion_product_type][google.cloud.retail.v2beta.ProductLevelConfig.ingestion_product_type]
	// if unset.
	Product_TYPE_UNSPECIFIED Product_Type = 0
	// The primary type.
	//
	// As the primary unit for predicting, indexing and search serving, a
	// [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2beta.Product] is grouped with multiple
	// [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2beta.Product]s.
	Product_PRIMARY Product_Type = 1
	// The variant type.
	//
	// [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2beta.Product]s usually share some common
	// attributes on the same
	// [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2beta.Product]s, but they have variant
	// attributes like different colors, sizes and prices, etc.
	Product_VARIANT Product_Type = 2
	// The collection type. Collection products are bundled
	// [Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2beta.Product]s or
	// [Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2beta.Product]s that are sold together,
	// such as a jewelry set with necklaces, earrings and rings, etc.
	Product_COLLECTION Product_Type = 3
)

func (Product_Type) Descriptor

func (Product_Type) Descriptor() protoreflect.EnumDescriptor

func (Product_Type) Enum

func (x Product_Type) Enum() *Product_Type

func (Product_Type) EnumDescriptor

func (Product_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Product_Type.Descriptor instead.

func (Product_Type) Number

func (x Product_Type) Number() protoreflect.EnumNumber

func (Product_Type) String

func (x Product_Type) String() string

func (Product_Type) Type

func (Product_Type) Type() protoreflect.EnumType

Promotion

type Promotion struct {

	// ID of the promotion. For example, "free gift".
	//
	// The value must be a UTF-8 encoded string with a length limit of 128
	// characters, and match the pattern: `[a-zA-Z][a-zA-Z0-9_]*`. For example,
	// id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
	// returned.
	//
	// Google Merchant Center property
	// [promotion](https://support.google.com/merchants/answer/7050148).
	PromotionId string `protobuf:"bytes,1,opt,name=promotion_id,json=promotionId,proto3" json:"promotion_id,omitempty"`
	// contains filtered or unexported fields
}

Promotion information.

func (*Promotion) Descriptor

func (*Promotion) Descriptor() ([]byte, []int)

Deprecated: Use Promotion.ProtoReflect.Descriptor instead.

func (*Promotion) GetPromotionId

func (x *Promotion) GetPromotionId() string

func (*Promotion) ProtoMessage

func (*Promotion) ProtoMessage()

func (*Promotion) ProtoReflect

func (x *Promotion) ProtoReflect() protoreflect.Message

func (*Promotion) Reset

func (x *Promotion) Reset()

func (*Promotion) String

func (x *Promotion) String() string

PurchaseTransaction

type PurchaseTransaction struct {

	// The transaction ID with a length limit of 128 characters.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Required. Total non-zero revenue or grand total associated with the
	// transaction. This value include shipping, tax, or other adjustments to
	// total revenue that you want to include as part of your revenue
	// calculations.
	Revenue float32 `protobuf:"fixed32,2,opt,name=revenue,proto3" json:"revenue,omitempty"`
	// All the taxes associated with the transaction.
	Tax float32 `protobuf:"fixed32,3,opt,name=tax,proto3" json:"tax,omitempty"`
	// All the costs associated with the products. These can be manufacturing
	// costs, shipping expenses not borne by the end user, or any other costs,
	// such that:
	//
	// * Profit =
	// [revenue][google.cloud.retail.v2beta.PurchaseTransaction.revenue] -
	// [tax][google.cloud.retail.v2beta.PurchaseTransaction.tax] -
	// [cost][google.cloud.retail.v2beta.PurchaseTransaction.cost]
	Cost float32 `protobuf:"fixed32,4,opt,name=cost,proto3" json:"cost,omitempty"`
	// Required. Currency code. Use three-character ISO-4217 code.
	CurrencyCode string `protobuf:"bytes,5,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// contains filtered or unexported fields
}

A transaction represents the entire purchase transaction.

func (*PurchaseTransaction) Descriptor

func (*PurchaseTransaction) Descriptor() ([]byte, []int)

Deprecated: Use PurchaseTransaction.ProtoReflect.Descriptor instead.

func (*PurchaseTransaction) GetCost

func (x *PurchaseTransaction) GetCost() float32

func (*PurchaseTransaction) GetCurrencyCode

func (x *PurchaseTransaction) GetCurrencyCode() string

func (*PurchaseTransaction) GetId

func (x *PurchaseTransaction) GetId() string

func (*PurchaseTransaction) GetRevenue

func (x *PurchaseTransaction) GetRevenue() float32

func (*PurchaseTransaction) GetTax

func (x *PurchaseTransaction) GetTax() float32

func (*PurchaseTransaction) ProtoMessage

func (*PurchaseTransaction) ProtoMessage()

func (*PurchaseTransaction) ProtoReflect

func (x *PurchaseTransaction) ProtoReflect() protoreflect.Message

func (*PurchaseTransaction) Reset

func (x *PurchaseTransaction) Reset()

func (*PurchaseTransaction) String

func (x *PurchaseTransaction) String() string

PurgeMetadata

type PurgeMetadata struct {
	// contains filtered or unexported fields
}

Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*PurgeMetadata) Descriptor

func (*PurgeMetadata) Descriptor() ([]byte, []int)

Deprecated: Use PurgeMetadata.ProtoReflect.Descriptor instead.

func (*PurgeMetadata) ProtoMessage

func (*PurgeMetadata) ProtoMessage()

func (*PurgeMetadata) ProtoReflect

func (x *PurgeMetadata) ProtoReflect() protoreflect.Message

func (*PurgeMetadata) Reset

func (x *PurgeMetadata) Reset()

func (*PurgeMetadata) String

func (x *PurgeMetadata) String() string

PurgeUserEventsRequest

type PurgeUserEventsRequest struct {

	// Required. The resource name of the catalog under which the events are
	// created. The format is
	// `projects/${projectId}/locations/global/catalogs/${catalogId}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The filter string to specify the events to be deleted with a
	// length limit of 5,000 characters. Empty string filter is not allowed. The
	// eligible fields for filtering are:
	//
	// * `eventType`: Double quoted
	// [UserEvent.event_type][google.cloud.retail.v2beta.UserEvent.event_type]
	// string.
	//   - `eventTime`: in ISO 8601 "zulu" format.
	//   - `visitorId`: Double quoted string. Specifying this will delete all
	//     events associated with a visitor.
	//   - `userId`: Double quoted string. Specifying this will delete all events
	//     associated with a user.
	//
	// Examples:
	//
	//   - Deleting all events in a time range:
	//     `eventTime > "2012-04-23T18:25:43.511Z"
	//     eventTime < "2012-04-23t18:30:43.511z"`="" -="" deleting="" specific="" eventtype="" in="" time="" range:="" `eventtime=""> "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
	//   - Deleting all events for a specific visitor:
	//     `visitorId = "visitor1024"`
	//
	// The filtering fields are assumed to have an implicit AND.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Actually perform the purge.
	// If `force` is set to false, the method will return the expected purge count
	// without deleting any user events.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for PurgeUserEvents method.

func (*PurgeUserEventsRequest) Descriptor

func (*PurgeUserEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use PurgeUserEventsRequest.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsRequest) GetFilter

func (x *PurgeUserEventsRequest) GetFilter() string

func (*PurgeUserEventsRequest) GetForce

func (x *PurgeUserEventsRequest) GetForce() bool

func (*PurgeUserEventsRequest) GetParent

func (x *PurgeUserEventsRequest) GetParent() string

func (*PurgeUserEventsRequest) ProtoMessage

func (*PurgeUserEventsRequest) ProtoMessage()

func (*PurgeUserEventsRequest) ProtoReflect

func (x *PurgeUserEventsRequest) ProtoReflect() protoreflect.Message

func (*PurgeUserEventsRequest) Reset

func (x *PurgeUserEventsRequest) Reset()

func (*PurgeUserEventsRequest) String

func (x *PurgeUserEventsRequest) String() string

PurgeUserEventsResponse

type PurgeUserEventsResponse struct {

	// The total count of events purged as a result of the operation.
	PurgedEventsCount int64 `protobuf:"varint,1,opt,name=purged_events_count,json=purgedEventsCount,proto3" json:"purged_events_count,omitempty"`
	// contains filtered or unexported fields
}

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

func (*PurgeUserEventsResponse) Descriptor

func (*PurgeUserEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use PurgeUserEventsResponse.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsResponse) GetPurgedEventsCount

func (x *PurgeUserEventsResponse) GetPurgedEventsCount() int64

func (*PurgeUserEventsResponse) ProtoMessage

func (*PurgeUserEventsResponse) ProtoMessage()

func (*PurgeUserEventsResponse) ProtoReflect

func (x *PurgeUserEventsResponse) ProtoReflect() protoreflect.Message

func (*PurgeUserEventsResponse) Reset

func (x *PurgeUserEventsResponse) Reset()

func (*PurgeUserEventsResponse) String

func (x *PurgeUserEventsResponse) String() string

Rating

type Rating struct {

	// The total number of ratings. This value is independent of the value of
	// [rating_histogram][google.cloud.retail.v2beta.Rating.rating_histogram].
	//
	// This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is
	// returned.
	RatingCount int32 `protobuf:"varint,1,opt,name=rating_count,json=ratingCount,proto3" json:"rating_count,omitempty"`
	// The average rating of the [Product][google.cloud.retail.v2beta.Product].
	//
	// The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is
	// returned.
	AverageRating float32 `protobuf:"fixed32,2,opt,name=average_rating,json=averageRating,proto3" json:"average_rating,omitempty"`
	// List of rating counts per rating value (index = rating - 1). The list is
	// empty if there is no rating. If the list is non-empty, its size is
	// always 5. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// For example, [41, 14, 13, 47, 303]. It means that the
	// [Product][google.cloud.retail.v2beta.Product] got 41 ratings with 1 star,
	// 14 ratings with 2 star, and so on.
	RatingHistogram []int32 `protobuf:"varint,3,rep,packed,name=rating_histogram,json=ratingHistogram,proto3" json:"rating_histogram,omitempty"`
	// contains filtered or unexported fields
}

The rating of a [Product][google.cloud.retail.v2beta.Product].

func (*Rating) Descriptor

func (*Rating) Descriptor() ([]byte, []int)

Deprecated: Use Rating.ProtoReflect.Descriptor instead.

func (*Rating) GetAverageRating

func (x *Rating) GetAverageRating() float32

func (*Rating) GetRatingCount

func (x *Rating) GetRatingCount() int32

func (*Rating) GetRatingHistogram

func (x *Rating) GetRatingHistogram() []int32

func (*Rating) ProtoMessage

func (*Rating) ProtoMessage()

func (*Rating) ProtoReflect

func (x *Rating) ProtoReflect() protoreflect.Message

func (*Rating) Reset

func (x *Rating) Reset()

func (*Rating) String

func (x *Rating) String() string

RecommendationsFilteringOption

type RecommendationsFilteringOption int32

If filtering for recommendations is enabled.

RecommendationsFilteringOption_RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED, RecommendationsFilteringOption_RECOMMENDATIONS_FILTERING_DISABLED, RecommendationsFilteringOption_RECOMMENDATIONS_FILTERING_ENABLED

const (
	// Value used when unset.
	// In this case, server behavior defaults to
	// [RECOMMENDATIONS_FILTERING_DISABLED][google.cloud.retail.v2beta.RecommendationsFilteringOption.RECOMMENDATIONS_FILTERING_DISABLED].
	RecommendationsFilteringOption_RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED RecommendationsFilteringOption = 0
	// Recommendation filtering is disabled.
	RecommendationsFilteringOption_RECOMMENDATIONS_FILTERING_DISABLED RecommendationsFilteringOption = 1
	// Recommendation filtering is enabled.
	RecommendationsFilteringOption_RECOMMENDATIONS_FILTERING_ENABLED RecommendationsFilteringOption = 3
)

func (RecommendationsFilteringOption) Descriptor

func (RecommendationsFilteringOption) Descriptor() protoreflect.EnumDescriptor

func (RecommendationsFilteringOption) Enum

func (x RecommendationsFilteringOption) Enum() *RecommendationsFilteringOption

func (RecommendationsFilteringOption) EnumDescriptor

func (RecommendationsFilteringOption) EnumDescriptor() ([]byte, []int)

Deprecated: Use RecommendationsFilteringOption.Descriptor instead.

func (RecommendationsFilteringOption) Number

func (x RecommendationsFilteringOption) Number() protoreflect.EnumNumber

func (RecommendationsFilteringOption) String

func (x RecommendationsFilteringOption) String() string

func (RecommendationsFilteringOption) Type

func (RecommendationsFilteringOption) Type() protoreflect.EnumType

RejoinUserEventsMetadata

type RejoinUserEventsMetadata struct {
	// contains filtered or unexported fields
}

Metadata for RejoinUserEvents method.

func (*RejoinUserEventsMetadata) Descriptor

func (*RejoinUserEventsMetadata) Descriptor() ([]byte, []int)

Deprecated: Use RejoinUserEventsMetadata.ProtoReflect.Descriptor instead.

func (*RejoinUserEventsMetadata) ProtoMessage

func (*RejoinUserEventsMetadata) ProtoMessage()

func (*RejoinUserEventsMetadata) ProtoReflect

func (x *RejoinUserEventsMetadata) ProtoReflect() protoreflect.Message

func (*RejoinUserEventsMetadata) Reset

func (x *RejoinUserEventsMetadata) Reset()

func (*RejoinUserEventsMetadata) String

func (x *RejoinUserEventsMetadata) String() string

RejoinUserEventsRequest

type RejoinUserEventsRequest struct {
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`

	UserEventRejoinScope RejoinUserEventsRequest_UserEventRejoinScope "" /* 203 byte string literal not displayed */

}

Request message for RejoinUserEvents method.

func (*RejoinUserEventsRequest) Descriptor

func (*RejoinUserEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use RejoinUserEventsRequest.ProtoReflect.Descriptor instead.

func (*RejoinUserEventsRequest) GetParent

func (x *RejoinUserEventsRequest) GetParent() string

func (*RejoinUserEventsRequest) GetUserEventRejoinScope

func (x *RejoinUserEventsRequest) GetUserEventRejoinScope() RejoinUserEventsRequest_UserEventRejoinScope

func (*RejoinUserEventsRequest) ProtoMessage

func (*RejoinUserEventsRequest) ProtoMessage()

func (*RejoinUserEventsRequest) ProtoReflect

func (x *RejoinUserEventsRequest) ProtoReflect() protoreflect.Message

func (*RejoinUserEventsRequest) Reset

func (x *RejoinUserEventsRequest) Reset()

func (*RejoinUserEventsRequest) String

func (x *RejoinUserEventsRequest) String() string

RejoinUserEventsRequest_UserEventRejoinScope

type RejoinUserEventsRequest_UserEventRejoinScope int32

The scope of user events to be rejoined with the latest product catalog. If the rejoining aims at reducing number of unjoined events, set UserEventRejoinScope to UNJOINED_EVENTS. If the rejoining aims at correcting product catalog information in joined events, set UserEventRejoinScope to JOINED_EVENTS. If all events needs to be rejoined, set UserEventRejoinScope to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED.

RejoinUserEventsRequest_USER_EVENT_REJOIN_SCOPE_UNSPECIFIED, RejoinUserEventsRequest_JOINED_EVENTS, RejoinUserEventsRequest_UNJOINED_EVENTS

const (
	// Rejoin all events with the latest product catalog, including both joined
	// events and unjoined events.
	RejoinUserEventsRequest_USER_EVENT_REJOIN_SCOPE_UNSPECIFIED RejoinUserEventsRequest_UserEventRejoinScope = 0
	// Only rejoin joined events with the latest product catalog.
	RejoinUserEventsRequest_JOINED_EVENTS RejoinUserEventsRequest_UserEventRejoinScope = 1
	// Only rejoin unjoined events with the latest product catalog.
	RejoinUserEventsRequest_UNJOINED_EVENTS RejoinUserEventsRequest_UserEventRejoinScope = 2
)

func (RejoinUserEventsRequest_UserEventRejoinScope) Descriptor

func (RejoinUserEventsRequest_UserEventRejoinScope) Descriptor() protoreflect.EnumDescriptor

func (RejoinUserEventsRequest_UserEventRejoinScope) Enum

func (x RejoinUserEventsRequest_UserEventRejoinScope) Enum() *RejoinUserEventsRequest_UserEventRejoinScope

func (RejoinUserEventsRequest_UserEventRejoinScope) EnumDescriptor

func (RejoinUserEventsRequest_UserEventRejoinScope) EnumDescriptor() ([]byte, []int)

Deprecated: Use RejoinUserEventsRequest_UserEventRejoinScope.Descriptor instead.

func (RejoinUserEventsRequest_UserEventRejoinScope) Number

func (x RejoinUserEventsRequest_UserEventRejoinScope) Number() protoreflect.EnumNumber

func (RejoinUserEventsRequest_UserEventRejoinScope) String

func (x RejoinUserEventsRequest_UserEventRejoinScope) String() string

func (RejoinUserEventsRequest_UserEventRejoinScope) Type

func (RejoinUserEventsRequest_UserEventRejoinScope) Type() protoreflect.EnumType

RejoinUserEventsResponse

type RejoinUserEventsResponse struct {
	RejoinedUserEventsCount int64 "" /* 135 byte string literal not displayed */

}

Response message for RejoinUserEvents method.

func (*RejoinUserEventsResponse) Descriptor

func (*RejoinUserEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use RejoinUserEventsResponse.ProtoReflect.Descriptor instead.

func (*RejoinUserEventsResponse) GetRejoinedUserEventsCount

func (x *RejoinUserEventsResponse) GetRejoinedUserEventsCount() int64

func (*RejoinUserEventsResponse) ProtoMessage

func (*RejoinUserEventsResponse) ProtoMessage()

func (*RejoinUserEventsResponse) ProtoReflect

func (x *RejoinUserEventsResponse) ProtoReflect() protoreflect.Message

func (*RejoinUserEventsResponse) Reset

func (x *RejoinUserEventsResponse) Reset()

func (*RejoinUserEventsResponse) String

func (x *RejoinUserEventsResponse) String() string

RemoveCatalogAttributeRequest

type RemoveCatalogAttributeRequest struct {

	// Required. Full AttributesConfig resource name. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
	AttributesConfig string `protobuf:"bytes,1,opt,name=attributes_config,json=attributesConfig,proto3" json:"attributes_config,omitempty"`
	// Required. The attribute name key of the
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to remove.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.RemoveCatalogAttribute][google.cloud.retail.v2beta.CatalogService.RemoveCatalogAttribute] method.

func (*RemoveCatalogAttributeRequest) Descriptor

func (*RemoveCatalogAttributeRequest) Descriptor() ([]byte, []int)

Deprecated: Use RemoveCatalogAttributeRequest.ProtoReflect.Descriptor instead.

func (*RemoveCatalogAttributeRequest) GetAttributesConfig

func (x *RemoveCatalogAttributeRequest) GetAttributesConfig() string

func (*RemoveCatalogAttributeRequest) GetKey

func (x *RemoveCatalogAttributeRequest) GetKey() string

func (*RemoveCatalogAttributeRequest) ProtoMessage

func (*RemoveCatalogAttributeRequest) ProtoMessage()

func (*RemoveCatalogAttributeRequest) ProtoReflect

func (x *RemoveCatalogAttributeRequest) ProtoReflect() protoreflect.Message

func (*RemoveCatalogAttributeRequest) Reset

func (x *RemoveCatalogAttributeRequest) Reset()

func (*RemoveCatalogAttributeRequest) String

func (x *RemoveCatalogAttributeRequest) String() string

RemoveControlRequest

type RemoveControlRequest struct {

	// Required. The source ServingConfig resource name . Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
	ServingConfig string `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// Required. The id of the control to apply. Assumed to be in the same catalog
	// as the serving config.
	ControlId string `protobuf:"bytes,2,opt,name=control_id,json=controlId,proto3" json:"control_id,omitempty"`
	// contains filtered or unexported fields
}

Request for RemoveControl method.

func (*RemoveControlRequest) Descriptor

func (*RemoveControlRequest) Descriptor() ([]byte, []int)

Deprecated: Use RemoveControlRequest.ProtoReflect.Descriptor instead.

func (*RemoveControlRequest) GetControlId

func (x *RemoveControlRequest) GetControlId() string

func (*RemoveControlRequest) GetServingConfig

func (x *RemoveControlRequest) GetServingConfig() string

func (*RemoveControlRequest) ProtoMessage

func (*RemoveControlRequest) ProtoMessage()

func (*RemoveControlRequest) ProtoReflect

func (x *RemoveControlRequest) ProtoReflect() protoreflect.Message

func (*RemoveControlRequest) Reset

func (x *RemoveControlRequest) Reset()

func (*RemoveControlRequest) String

func (x *RemoveControlRequest) String() string

RemoveFulfillmentPlacesMetadata

type RemoveFulfillmentPlacesMetadata struct {
	// contains filtered or unexported fields
}

Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces] method.

func (*RemoveFulfillmentPlacesMetadata) Descriptor

func (*RemoveFulfillmentPlacesMetadata) Descriptor() ([]byte, []int)

Deprecated: Use RemoveFulfillmentPlacesMetadata.ProtoReflect.Descriptor instead.

func (*RemoveFulfillmentPlacesMetadata) ProtoMessage

func (*RemoveFulfillmentPlacesMetadata) ProtoMessage()

func (*RemoveFulfillmentPlacesMetadata) ProtoReflect

func (x *RemoveFulfillmentPlacesMetadata) ProtoReflect() protoreflect.Message

func (*RemoveFulfillmentPlacesMetadata) Reset

func (x *RemoveFulfillmentPlacesMetadata) Reset()

func (*RemoveFulfillmentPlacesMetadata) String

func (x *RemoveFulfillmentPlacesMetadata) String() string

RemoveFulfillmentPlacesRequest

type RemoveFulfillmentPlacesRequest struct {

	// Required. Full resource name of
	// [Product][google.cloud.retail.v2beta.Product], such as
	// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
	//
	// If the caller does not have permission to access the
	// [Product][google.cloud.retail.v2beta.Product], regardless of whether or not
	// it exists, a PERMISSION_DENIED error is returned.
	Product string `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
	// Required. The fulfillment type, including commonly used types (such as
	// pickup in store and same day delivery), and custom types.
	//
	// Supported values:
	//
	// * "pickup-in-store"
	// * "ship-to-store"
	// * "same-day-delivery"
	// * "next-day-delivery"
	// * "custom-type-1"
	// * "custom-type-2"
	// * "custom-type-3"
	// * "custom-type-4"
	// * "custom-type-5"
	//
	// If this field is set to an invalid value other than these, an
	// INVALID_ARGUMENT error is returned.
	//
	// This field directly corresponds to
	// [Product.fulfillment_info.type][google.cloud.retail.v2beta.FulfillmentInfo.type].
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Required. The IDs for this
	// [type][google.cloud.retail.v2beta.RemoveFulfillmentPlacesRequest.type],
	// such as the store IDs for "pickup-in-store" or the region IDs for
	// "same-day-delivery", to be removed for this
	// [type][google.cloud.retail.v2beta.RemoveFulfillmentPlacesRequest.type].
	//
	// At least 1 value is required, and a maximum of 2000 values are allowed.
	// Each value must be a string with a length limit of 10 characters, matching
	// the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
	// INVALID_ARGUMENT error is returned.
	PlaceIds []string `protobuf:"bytes,3,rep,name=place_ids,json=placeIds,proto3" json:"place_ids,omitempty"`
	// The time when the fulfillment updates are issued, used to prevent
	// out-of-order updates on fulfillment information. If not provided, the
	// internal system time will be used.
	RemoveTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=remove_time,json=removeTime,proto3" json:"remove_time,omitempty"`
	// If set to true, and the [Product][google.cloud.retail.v2beta.Product] is
	// not found, the fulfillment information will still be processed and retained
	// for at most 1 day and processed once the
	// [Product][google.cloud.retail.v2beta.Product] is created. If set to false,
	// a NOT_FOUND error is returned if the
	// [Product][google.cloud.retail.v2beta.Product] is not found.
	AllowMissing bool `protobuf:"varint,5,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces] method.

func (*RemoveFulfillmentPlacesRequest) Descriptor

func (*RemoveFulfillmentPlacesRequest) Descriptor() ([]byte, []int)

Deprecated: Use RemoveFulfillmentPlacesRequest.ProtoReflect.Descriptor instead.

func (*RemoveFulfillmentPlacesRequest) GetAllowMissing

func (x *RemoveFulfillmentPlacesRequest) GetAllowMissing() bool

func (*RemoveFulfillmentPlacesRequest) GetPlaceIds

func (x *RemoveFulfillmentPlacesRequest) GetPlaceIds() []string

func (*RemoveFulfillmentPlacesRequest) GetProduct

func (x *RemoveFulfillmentPlacesRequest) GetProduct() string

func (*RemoveFulfillmentPlacesRequest) GetRemoveTime

func (x *RemoveFulfillmentPlacesRequest) GetRemoveTime() *timestamppb.Timestamp

func (*RemoveFulfillmentPlacesRequest) GetType

func (x *RemoveFulfillmentPlacesRequest) GetType() string

func (*RemoveFulfillmentPlacesRequest) ProtoMessage

func (*RemoveFulfillmentPlacesRequest) ProtoMessage()

func (*RemoveFulfillmentPlacesRequest) ProtoReflect

func (x *RemoveFulfillmentPlacesRequest) ProtoReflect() protoreflect.Message

func (*RemoveFulfillmentPlacesRequest) Reset

func (x *RemoveFulfillmentPlacesRequest) Reset()

func (*RemoveFulfillmentPlacesRequest) String

func (x *RemoveFulfillmentPlacesRequest) String() string

RemoveFulfillmentPlacesResponse

type RemoveFulfillmentPlacesResponse struct {
	// contains filtered or unexported fields
}

Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces] method.

func (*RemoveFulfillmentPlacesResponse) Descriptor

func (*RemoveFulfillmentPlacesResponse) Descriptor() ([]byte, []int)

Deprecated: Use RemoveFulfillmentPlacesResponse.ProtoReflect.Descriptor instead.

func (*RemoveFulfillmentPlacesResponse) ProtoMessage

func (*RemoveFulfillmentPlacesResponse) ProtoMessage()

func (*RemoveFulfillmentPlacesResponse) ProtoReflect

func (x *RemoveFulfillmentPlacesResponse) ProtoReflect() protoreflect.Message

func (*RemoveFulfillmentPlacesResponse) Reset

func (x *RemoveFulfillmentPlacesResponse) Reset()

func (*RemoveFulfillmentPlacesResponse) String

func (x *RemoveFulfillmentPlacesResponse) String() string

RemoveLocalInventoriesMetadata

type RemoveLocalInventoriesMetadata struct {
	// contains filtered or unexported fields
}

Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] method.

func (*RemoveLocalInventoriesMetadata) Descriptor

func (*RemoveLocalInventoriesMetadata) Descriptor() ([]byte, []int)

Deprecated: Use RemoveLocalInventoriesMetadata.ProtoReflect.Descriptor instead.

func (*RemoveLocalInventoriesMetadata) ProtoMessage

func (*RemoveLocalInventoriesMetadata) ProtoMessage()

func (*RemoveLocalInventoriesMetadata) ProtoReflect

func (x *RemoveLocalInventoriesMetadata) ProtoReflect() protoreflect.Message

func (*RemoveLocalInventoriesMetadata) Reset

func (x *RemoveLocalInventoriesMetadata) Reset()

func (*RemoveLocalInventoriesMetadata) String

func (x *RemoveLocalInventoriesMetadata) String() string

RemoveLocalInventoriesRequest

type RemoveLocalInventoriesRequest struct {

	// Required. Full resource name of
	// [Product][google.cloud.retail.v2beta.Product], such as
	// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
	//
	// If the caller does not have permission to access the
	// [Product][google.cloud.retail.v2beta.Product], regardless of whether or not
	// it exists, a PERMISSION_DENIED error is returned.
	Product string `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
	// Required. A list of place IDs to have their inventory deleted.
	// At most 3000 place IDs are allowed per request.
	PlaceIds []string `protobuf:"bytes,2,rep,name=place_ids,json=placeIds,proto3" json:"place_ids,omitempty"`
	// The time when the inventory deletions are issued. Used to prevent
	// out-of-order updates and deletions on local inventory fields. If not
	// provided, the internal system time will be used.
	RemoveTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=remove_time,json=removeTime,proto3" json:"remove_time,omitempty"`
	// If set to true, and the [Product][google.cloud.retail.v2beta.Product] is
	// not found, the local inventory removal request will still be processed and
	// retained for at most 1 day and processed once the
	// [Product][google.cloud.retail.v2beta.Product] is created. If set to false,
	// a NOT_FOUND error is returned if the
	// [Product][google.cloud.retail.v2beta.Product] is not found.
	AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] method.

func (*RemoveLocalInventoriesRequest) Descriptor

func (*RemoveLocalInventoriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use RemoveLocalInventoriesRequest.ProtoReflect.Descriptor instead.

func (*RemoveLocalInventoriesRequest) GetAllowMissing

func (x *RemoveLocalInventoriesRequest) GetAllowMissing() bool

func (*RemoveLocalInventoriesRequest) GetPlaceIds

func (x *RemoveLocalInventoriesRequest) GetPlaceIds() []string

func (*RemoveLocalInventoriesRequest) GetProduct

func (x *RemoveLocalInventoriesRequest) GetProduct() string

func (*RemoveLocalInventoriesRequest) GetRemoveTime

func (x *RemoveLocalInventoriesRequest) GetRemoveTime() *timestamppb.Timestamp

func (*RemoveLocalInventoriesRequest) ProtoMessage

func (*RemoveLocalInventoriesRequest) ProtoMessage()

func (*RemoveLocalInventoriesRequest) ProtoReflect

func (x *RemoveLocalInventoriesRequest) ProtoReflect() protoreflect.Message

func (*RemoveLocalInventoriesRequest) Reset

func (x *RemoveLocalInventoriesRequest) Reset()

func (*RemoveLocalInventoriesRequest) String

func (x *RemoveLocalInventoriesRequest) String() string

RemoveLocalInventoriesResponse

type RemoveLocalInventoriesResponse struct {
	// contains filtered or unexported fields
}

Response of the [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] API. Currently empty because there is no meaningful response populated from the [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] method.

func (*RemoveLocalInventoriesResponse) Descriptor

func (*RemoveLocalInventoriesResponse) Descriptor() ([]byte, []int)

Deprecated: Use RemoveLocalInventoriesResponse.ProtoReflect.Descriptor instead.

func (*RemoveLocalInventoriesResponse) ProtoMessage

func (*RemoveLocalInventoriesResponse) ProtoMessage()

func (*RemoveLocalInventoriesResponse) ProtoReflect

func (x *RemoveLocalInventoriesResponse) ProtoReflect() protoreflect.Message

func (*RemoveLocalInventoriesResponse) Reset

func (x *RemoveLocalInventoriesResponse) Reset()

func (*RemoveLocalInventoriesResponse) String

func (x *RemoveLocalInventoriesResponse) String() string

ReplaceCatalogAttributeRequest

type ReplaceCatalogAttributeRequest struct {

	// Required. Full AttributesConfig resource name. Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
	AttributesConfig string `protobuf:"bytes,1,opt,name=attributes_config,json=attributesConfig,proto3" json:"attributes_config,omitempty"`
	// Required. The updated
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute].
	CatalogAttribute *CatalogAttribute `protobuf:"bytes,2,opt,name=catalog_attribute,json=catalogAttribute,proto3" json:"catalog_attribute,omitempty"`
	// Indicates which fields in the provided
	// [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to update.
	// The following are NOT supported:
	//
	// * [CatalogAttribute.key][google.cloud.retail.v2beta.CatalogAttribute.key]
	//
	// If not set, all supported fields are updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.ReplaceCatalogAttribute][google.cloud.retail.v2beta.CatalogService.ReplaceCatalogAttribute] method.

func (*ReplaceCatalogAttributeRequest) Descriptor

func (*ReplaceCatalogAttributeRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReplaceCatalogAttributeRequest.ProtoReflect.Descriptor instead.

func (*ReplaceCatalogAttributeRequest) GetAttributesConfig

func (x *ReplaceCatalogAttributeRequest) GetAttributesConfig() string

func (*ReplaceCatalogAttributeRequest) GetCatalogAttribute

func (x *ReplaceCatalogAttributeRequest) GetCatalogAttribute() *CatalogAttribute

func (*ReplaceCatalogAttributeRequest) GetUpdateMask

func (x *ReplaceCatalogAttributeRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*ReplaceCatalogAttributeRequest) ProtoMessage

func (*ReplaceCatalogAttributeRequest) ProtoMessage()

func (*ReplaceCatalogAttributeRequest) ProtoReflect

func (x *ReplaceCatalogAttributeRequest) ProtoReflect() protoreflect.Message

func (*ReplaceCatalogAttributeRequest) Reset

func (x *ReplaceCatalogAttributeRequest) Reset()

func (*ReplaceCatalogAttributeRequest) String

func (x *ReplaceCatalogAttributeRequest) String() string

ResumeModelRequest

type ResumeModelRequest struct {

	// Required. The name of the model to resume.
	// Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for resuming training of a model.

func (*ResumeModelRequest) Descriptor

func (*ResumeModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use ResumeModelRequest.ProtoReflect.Descriptor instead.

func (*ResumeModelRequest) GetName

func (x *ResumeModelRequest) GetName() string

func (*ResumeModelRequest) ProtoMessage

func (*ResumeModelRequest) ProtoMessage()

func (*ResumeModelRequest) ProtoReflect

func (x *ResumeModelRequest) ProtoReflect() protoreflect.Message

func (*ResumeModelRequest) Reset

func (x *ResumeModelRequest) Reset()

func (*ResumeModelRequest) String

func (x *ResumeModelRequest) String() string

Rule

type Rule struct {

	// An action must be provided.
	//
	// Types that are assignable to Action:
	//
	//	*Rule_BoostAction_
	//	*Rule_RedirectAction_
	//	*Rule_OnewaySynonymsAction_
	//	*Rule_DoNotAssociateAction_
	//	*Rule_ReplacementAction_
	//	*Rule_IgnoreAction_
	//	*Rule_FilterAction_
	//	*Rule_TwowaySynonymsAction_
	Action isRule_Action `protobuf_oneof:"action"`
	// Required. The condition that triggers the rule.
	// If the condition is empty, the rule will always apply.
	Condition *Condition `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"`
	// contains filtered or unexported fields
}

A rule is a condition-action pair

• A condition defines when a rule is to be triggered.
• An action specifies what occurs on that trigger. Currently rules only work for [controls][google.cloud.retail.v2beta.Control] with [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2beta.SolutionType.SOLUTION_TYPE_SEARCH].

func (*Rule) Descriptor

func (*Rule) Descriptor() ([]byte, []int)

Deprecated: Use Rule.ProtoReflect.Descriptor instead.

func (*Rule) GetAction

func (m *Rule) GetAction() isRule_Action

func (*Rule) GetBoostAction

func (x *Rule) GetBoostAction() *Rule_BoostAction

func (*Rule) GetCondition

func (x *Rule) GetCondition() *Condition

func (*Rule) GetDoNotAssociateAction

func (x *Rule) GetDoNotAssociateAction() *Rule_DoNotAssociateAction

func (*Rule) GetFilterAction

func (x *Rule) GetFilterAction() *Rule_FilterAction

func (*Rule) GetIgnoreAction

func (x *Rule) GetIgnoreAction() *Rule_IgnoreAction

func (*Rule) GetOnewaySynonymsAction

func (x *Rule) GetOnewaySynonymsAction() *Rule_OnewaySynonymsAction

func (*Rule) GetRedirectAction

func (x *Rule) GetRedirectAction() *Rule_RedirectAction

func (*Rule) GetReplacementAction

func (x *Rule) GetReplacementAction() *Rule_ReplacementAction

func (*Rule) GetTwowaySynonymsAction

func (x *Rule) GetTwowaySynonymsAction() *Rule_TwowaySynonymsAction

func (*Rule) ProtoMessage

func (*Rule) ProtoMessage()

func (*Rule) ProtoReflect

func (x *Rule) ProtoReflect() protoreflect.Message

func (*Rule) Reset

func (x *Rule) Reset()

func (*Rule) String

func (x *Rule) String() string

Rule_BoostAction

type Rule_BoostAction struct {

	// Strength of the condition boost, which must be in [-1, 1]. Negative
	// boost means demotion. Default is 0.0.
	//
	// Setting to 1.0 gives the item a big promotion. However, it does not
	// necessarily mean that the boosted item will be the top result at all
	// times, nor that other items will be excluded. Results could still be
	// shown even when none of them matches the condition. And results that
	// are significantly more relevant to the search query can still trump
	// your heavily favored but irrelevant items.
	//
	// Setting to -1.0 gives the item a big demotion. However, results that
	// are deeply relevant might still be shown. The item will have an
	// upstream battle to get a fairly high ranking, but it is not blocked out
	// completely.
	//
	// Setting to 0.0 means no boost applied. The boosting condition is
	// ignored.
	Boost float32 `protobuf:"fixed32,1,opt,name=boost,proto3" json:"boost,omitempty"`
	// The filter can have a max size of 5000 characters.
	// An expression which specifies which products to apply an action to.
	// The syntax and supported fields are the same as a filter expression. See
	// [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter]
	// for detail syntax and limitations.
	//
	// Examples:
	//
	// * To boost products with product ID "product_1" or "product_2", and
	// color
	//
	//	"Red" or "Blue":

	//	*(id: ANY("product_1", "product_2"))
*
	//	*AND
*
	//	*(colorFamilies: ANY("Red", "Blue"))
*
	ProductsFilter string `protobuf:"bytes,2,opt,name=products_filter,json=productsFilter,proto3" json:"products_filter,omitempty"`
	// contains filtered or unexported fields
}

A boost action to apply to results matching condition specified above.

func (*Rule_BoostAction) Descriptor

func (*Rule_BoostAction) Descriptor() ([]byte, []int)

Deprecated: Use Rule_BoostAction.ProtoReflect.Descriptor instead.

func (*Rule_BoostAction) GetBoost

func (x *Rule_BoostAction) GetBoost() float32

func (*Rule_BoostAction) GetProductsFilter

func (x *Rule_BoostAction) GetProductsFilter() string

func (*Rule_BoostAction) ProtoMessage

func (*Rule_BoostAction) ProtoMessage()

func (*Rule_BoostAction) ProtoReflect

func (x *Rule_BoostAction) ProtoReflect() protoreflect.Message

func (*Rule_BoostAction) Reset

func (x *Rule_BoostAction) Reset()

func (*Rule_BoostAction) String

func (x *Rule_BoostAction) String() string

Rule_BoostAction_

type Rule_BoostAction_ struct {
	// A boost action.
	BoostAction *Rule_BoostAction `protobuf:"bytes,2,opt,name=boost_action,json=boostAction,proto3,oneof"`
}

Rule_DoNotAssociateAction

type Rule_DoNotAssociateAction struct {

	// Terms from the search query.
	// Will not consider do_not_associate_terms for search if in search query.
	// Can specify up to 100 terms.
	QueryTerms []string `protobuf:"bytes,2,rep,name=query_terms,json=queryTerms,proto3" json:"query_terms,omitempty"`
	// Cannot contain duplicates or the query term.
	// Can specify up to 100 terms.
	DoNotAssociateTerms []string `protobuf:"bytes,3,rep,name=do_not_associate_terms,json=doNotAssociateTerms,proto3" json:"do_not_associate_terms,omitempty"`
	// Will be [deprecated = true] post migration;
	Terms []string `protobuf:"bytes,1,rep,name=terms,proto3" json:"terms,omitempty"`
	// contains filtered or unexported fields
}

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".

func (*Rule_DoNotAssociateAction) Descriptor

func (*Rule_DoNotAssociateAction) Descriptor() ([]byte, []int)

Deprecated: Use Rule_DoNotAssociateAction.ProtoReflect.Descriptor instead.

func (*Rule_DoNotAssociateAction) GetDoNotAssociateTerms

func (x *Rule_DoNotAssociateAction) GetDoNotAssociateTerms() []string

func (*Rule_DoNotAssociateAction) GetQueryTerms

func (x *Rule_DoNotAssociateAction) GetQueryTerms() []string

func (*Rule_DoNotAssociateAction) GetTerms

func (x *Rule_DoNotAssociateAction) GetTerms() []string

func (*Rule_DoNotAssociateAction) ProtoMessage

func (*Rule_DoNotAssociateAction) ProtoMessage()

func (*Rule_DoNotAssociateAction) ProtoReflect

func (x *Rule_DoNotAssociateAction) ProtoReflect() protoreflect.Message

func (*Rule_DoNotAssociateAction) Reset

func (x *Rule_DoNotAssociateAction) Reset()

func (*Rule_DoNotAssociateAction) String

func (x *Rule_DoNotAssociateAction) String() string

Rule_DoNotAssociateAction_

type Rule_DoNotAssociateAction_ struct {
	// Prevents term from being associated with other terms.
	DoNotAssociateAction *Rule_DoNotAssociateAction `protobuf:"bytes,7,opt,name=do_not_associate_action,json=doNotAssociateAction,proto3,oneof"`
}

Rule_FilterAction

type Rule_FilterAction struct {

	// A filter to apply on the matching condition results. Supported features:
	//
	// * [filter][google.cloud.retail.v2beta.Rule.FilterAction.filter] must be
	// set.
	// * Filter syntax is identical to
	// [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter].
	// See more
	//
	//	details at the Retail Search
	//	[user guide](/retail/search/docs/filter-and-order#filter).
	//
	// * To filter products with product ID "product_1" or "product_2", and
	// color
	//
	//	"Red" or "Blue":

	//	*(id: ANY("product_1", "product_2"))
*
	//	*AND
*
	//	*(colorFamilies: ANY("Red", "Blue"))
*
	Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

• Rule Condition:

  • No [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms] provided is a global match.
  • 1 or more [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms] provided are combined with OR operator.

• Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.

• Action Result: Filters the returned objects to be ONLY those that passed the filter.

func (*Rule_FilterAction) Descriptor

func (*Rule_FilterAction) Descriptor() ([]byte, []int)

Deprecated: Use Rule_FilterAction.ProtoReflect.Descriptor instead.

func (*Rule_FilterAction) GetFilter

func (x *Rule_FilterAction) GetFilter() string

func (*Rule_FilterAction) ProtoMessage

func (*Rule_FilterAction) ProtoMessage()

func (*Rule_FilterAction) ProtoReflect

func (x *Rule_FilterAction) ProtoReflect() protoreflect.Message

func (*Rule_FilterAction) Reset

func (x *Rule_FilterAction) Reset()

func (*Rule_FilterAction) String

func (x *Rule_FilterAction) String() string

Rule_FilterAction_

type Rule_FilterAction_ struct {
	// Filters results.
	FilterAction *Rule_FilterAction `protobuf:"bytes,10,opt,name=filter_action,json=filterAction,proto3,oneof"`
}

Rule_IgnoreAction

type Rule_IgnoreAction struct {

	// Terms to ignore in the search query.
	IgnoreTerms []string `protobuf:"bytes,1,rep,name=ignore_terms,json=ignoreTerms,proto3" json:"ignore_terms,omitempty"`
	// contains filtered or unexported fields
}

Prevents a term in the query from being used in search. Example: Don't search for "shoddy".

func (*Rule_IgnoreAction) Descriptor

func (*Rule_IgnoreAction) Descriptor() ([]byte, []int)

Deprecated: Use Rule_IgnoreAction.ProtoReflect.Descriptor instead.

func (*Rule_IgnoreAction) GetIgnoreTerms

func (x *Rule_IgnoreAction) GetIgnoreTerms() []string

func (*Rule_IgnoreAction) ProtoMessage

func (*Rule_IgnoreAction) ProtoMessage()

func (*Rule_IgnoreAction) ProtoReflect

func (x *Rule_IgnoreAction) ProtoReflect() protoreflect.Message

func (*Rule_IgnoreAction) Reset

func (x *Rule_IgnoreAction) Reset()

func (*Rule_IgnoreAction) String

func (x *Rule_IgnoreAction) String() string

Rule_IgnoreAction_

type Rule_IgnoreAction_ struct {
	// Ignores specific terms from query during search.
	IgnoreAction *Rule_IgnoreAction `protobuf:"bytes,9,opt,name=ignore_action,json=ignoreAction,proto3,oneof"`
}

Rule_OnewaySynonymsAction

type Rule_OnewaySynonymsAction struct {

	// Terms from the search query.
	// Will treat synonyms as their synonyms.
	// Not themselves synonyms of the synonyms.
	// Can specify up to 100 terms.
	QueryTerms []string `protobuf:"bytes,3,rep,name=query_terms,json=queryTerms,proto3" json:"query_terms,omitempty"`
	// Defines a set of synonyms.
	// Cannot contain duplicates.
	// Can specify up to 100 synonyms.
	Synonyms []string `protobuf:"bytes,4,rep,name=synonyms,proto3" json:"synonyms,omitempty"`
	// Will be [deprecated = true] post migration;
	OnewayTerms []string `protobuf:"bytes,2,rep,name=oneway_terms,json=onewayTerms,proto3" json:"oneway_terms,omitempty"`
	// contains filtered or unexported fields
}

Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".

func (*Rule_OnewaySynonymsAction) Descriptor

func (*Rule_OnewaySynonymsAction) Descriptor() ([]byte, []int)

Deprecated: Use Rule_OnewaySynonymsAction.ProtoReflect.Descriptor instead.

func (*Rule_OnewaySynonymsAction) GetOnewayTerms

func (x *Rule_OnewaySynonymsAction) GetOnewayTerms() []string

func (*Rule_OnewaySynonymsAction) GetQueryTerms

func (x *Rule_OnewaySynonymsAction) GetQueryTerms() []string

func (*Rule_OnewaySynonymsAction) GetSynonyms

func (x *Rule_OnewaySynonymsAction) GetSynonyms() []string

func (*Rule_OnewaySynonymsAction) ProtoMessage

func (*Rule_OnewaySynonymsAction) ProtoMessage()

func (*Rule_OnewaySynonymsAction) ProtoReflect

func (x *Rule_OnewaySynonymsAction) ProtoReflect() protoreflect.Message

func (*Rule_OnewaySynonymsAction) Reset

func (x *Rule_OnewaySynonymsAction) Reset()

func (*Rule_OnewaySynonymsAction) String

func (x *Rule_OnewaySynonymsAction) String() string

Rule_OnewaySynonymsAction_

type Rule_OnewaySynonymsAction_ struct {
	// Treats specific term as a synonym with a group of terms.
	// Group of terms will not be treated as synonyms with the specific term.
	OnewaySynonymsAction *Rule_OnewaySynonymsAction `protobuf:"bytes,6,opt,name=oneway_synonyms_action,json=onewaySynonymsAction,proto3,oneof"`
}

Rule_RedirectAction

type Rule_RedirectAction struct {

	// URL must have length equal or less than 2000 characters.
	RedirectUri string `protobuf:"bytes,1,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`
	// contains filtered or unexported fields
}

Redirects a shopper to a specific page.

• Rule Condition:

  • Must specify [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms].

• Action Input: Request Query

• Action Result: Redirects shopper to provided uri.

func (*Rule_RedirectAction) Descriptor

func (*Rule_RedirectAction) Descriptor() ([]byte, []int)

Deprecated: Use Rule_RedirectAction.ProtoReflect.Descriptor instead.

func (*Rule_RedirectAction) GetRedirectUri

func (x *Rule_RedirectAction) GetRedirectUri() string

func (*Rule_RedirectAction) ProtoMessage

func (*Rule_RedirectAction) ProtoMessage()

func (*Rule_RedirectAction) ProtoReflect

func (x *Rule_RedirectAction) ProtoReflect() protoreflect.Message

func (*Rule_RedirectAction) Reset

func (x *Rule_RedirectAction) Reset()

func (*Rule_RedirectAction) String

func (x *Rule_RedirectAction) String() string

Rule_RedirectAction_

type Rule_RedirectAction_ struct {
	// Redirects a shopper to a specific page.
	RedirectAction *Rule_RedirectAction `protobuf:"bytes,3,opt,name=redirect_action,json=redirectAction,proto3,oneof"`
}

Rule_ReplacementAction

type Rule_ReplacementAction struct {

	// Terms from the search query.
	// Will be replaced by replacement term.
	// Can specify up to 100 terms.
	QueryTerms []string `protobuf:"bytes,2,rep,name=query_terms,json=queryTerms,proto3" json:"query_terms,omitempty"`
	// Term that will be used for replacement.
	ReplacementTerm string `protobuf:"bytes,3,opt,name=replacement_term,json=replacementTerm,proto3" json:"replacement_term,omitempty"`
	// Will be [deprecated = true] post migration;
	Term string `protobuf:"bytes,1,opt,name=term,proto3" json:"term,omitempty"`
	// contains filtered or unexported fields
}

Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".

func (*Rule_ReplacementAction) Descriptor

func (*Rule_ReplacementAction) Descriptor() ([]byte, []int)

Deprecated: Use Rule_ReplacementAction.ProtoReflect.Descriptor instead.

func (*Rule_ReplacementAction) GetQueryTerms

func (x *Rule_ReplacementAction) GetQueryTerms() []string

func (*Rule_ReplacementAction) GetReplacementTerm

func (x *Rule_ReplacementAction) GetReplacementTerm() string

func (*Rule_ReplacementAction) GetTerm

func (x *Rule_ReplacementAction) GetTerm() string

func (*Rule_ReplacementAction) ProtoMessage

func (*Rule_ReplacementAction) ProtoMessage()

func (*Rule_ReplacementAction) ProtoReflect

func (x *Rule_ReplacementAction) ProtoReflect() protoreflect.Message

func (*Rule_ReplacementAction) Reset

func (x *Rule_ReplacementAction) Reset()

func (*Rule_ReplacementAction) String

func (x *Rule_ReplacementAction) String() string

Rule_ReplacementAction_

type Rule_ReplacementAction_ struct {
	// Replaces specific terms in the query.
	ReplacementAction *Rule_ReplacementAction `protobuf:"bytes,8,opt,name=replacement_action,json=replacementAction,proto3,oneof"`
}

Rule_TwowaySynonymsAction

type Rule_TwowaySynonymsAction struct {

	// Defines a set of synonyms.
	// Can specify up to 100 synonyms.
	// Must specify at least 2 synonyms.
	Synonyms []string `protobuf:"bytes,1,rep,name=synonyms,proto3" json:"synonyms,omitempty"`
	// contains filtered or unexported fields
}

Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes":

• "sneakers" will use a synonym of "shoes".
• "shoes" will use a synonym of "sneakers".

func (*Rule_TwowaySynonymsAction) Descriptor

func (*Rule_TwowaySynonymsAction) Descriptor() ([]byte, []int)

Deprecated: Use Rule_TwowaySynonymsAction.ProtoReflect.Descriptor instead.

func (*Rule_TwowaySynonymsAction) GetSynonyms

func (x *Rule_TwowaySynonymsAction) GetSynonyms() []string

func (*Rule_TwowaySynonymsAction) ProtoMessage

func (*Rule_TwowaySynonymsAction) ProtoMessage()

func (*Rule_TwowaySynonymsAction) ProtoReflect

func (x *Rule_TwowaySynonymsAction) ProtoReflect() protoreflect.Message

func (*Rule_TwowaySynonymsAction) Reset

func (x *Rule_TwowaySynonymsAction) Reset()

func (*Rule_TwowaySynonymsAction) String

func (x *Rule_TwowaySynonymsAction) String() string

Rule_TwowaySynonymsAction_

type Rule_TwowaySynonymsAction_ struct {
	// Treats a set of terms as synonyms of one another.
	TwowaySynonymsAction *Rule_TwowaySynonymsAction `protobuf:"bytes,11,opt,name=twoway_synonyms_action,json=twowaySynonymsAction,proto3,oneof"`
}

SearchRequest

type SearchRequest struct {
	Placement string `protobuf:"bytes,1,opt,name=placement,proto3" json:"placement,omitempty"`

	Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"`

	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`

	VisitorId string `protobuf:"bytes,4,opt,name=visitor_id,json=visitorId,proto3" json:"visitor_id,omitempty"`

	UserInfo *UserInfo `protobuf:"bytes,5,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`

	PageSize int32 `protobuf:"varint,7,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`

	PageToken string `protobuf:"bytes,8,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`

	Offset int32 `protobuf:"varint,9,opt,name=offset,proto3" json:"offset,omitempty"`

	Filter string `protobuf:"bytes,10,opt,name=filter,proto3" json:"filter,omitempty"`

	CanonicalFilter string `protobuf:"bytes,28,opt,name=canonical_filter,json=canonicalFilter,proto3" json:"canonical_filter,omitempty"`

	OrderBy string `protobuf:"bytes,11,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`

	FacetSpecs []*SearchRequest_FacetSpec `protobuf:"bytes,12,rep,name=facet_specs,json=facetSpecs,proto3" json:"facet_specs,omitempty"`

	DynamicFacetSpec *SearchRequest_DynamicFacetSpec `protobuf:"bytes,21,opt,name=dynamic_facet_spec,json=dynamicFacetSpec,proto3" json:"dynamic_facet_spec,omitempty"`

	BoostSpec *SearchRequest_BoostSpec `protobuf:"bytes,13,opt,name=boost_spec,json=boostSpec,proto3" json:"boost_spec,omitempty"`

	QueryExpansionSpec *SearchRequest_QueryExpansionSpec `protobuf:"bytes,14,opt,name=query_expansion_spec,json=queryExpansionSpec,proto3" json:"query_expansion_spec,omitempty"`

	VariantRollupKeys []string `protobuf:"bytes,17,rep,name=variant_rollup_keys,json=variantRollupKeys,proto3" json:"variant_rollup_keys,omitempty"`

	PageCategories []string `protobuf:"bytes,23,rep,name=page_categories,json=pageCategories,proto3" json:"page_categories,omitempty"`

	SearchMode SearchRequest_SearchMode "" /* 150 byte string literal not displayed */

	PersonalizationSpec *SearchRequest_PersonalizationSpec `protobuf:"bytes,32,opt,name=personalization_spec,json=personalizationSpec,proto3" json:"personalization_spec,omitempty"`

	Labels map[string]string "" /* 154 byte string literal not displayed */

	SpellCorrectionSpec *SearchRequest_SpellCorrectionSpec "" /* 127 byte string literal not displayed */

	Entity string `protobuf:"bytes,38,opt,name=entity,proto3" json:"entity,omitempty"`

}

Request message for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] method.

func (*SearchRequest) Descriptor

func (*SearchRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetBoostSpec

func (x *SearchRequest) GetBoostSpec() *SearchRequest_BoostSpec

func (*SearchRequest) GetBranch

func (x *SearchRequest) GetBranch() string

func (*SearchRequest) GetCanonicalFilter

func (x *SearchRequest) GetCanonicalFilter() string

func (*SearchRequest) GetDynamicFacetSpec

func (x *SearchRequest) GetDynamicFacetSpec() *SearchRequest_DynamicFacetSpec

Deprecated: Marked as deprecated in google/cloud/retail/v2beta/search_service.proto.

func (*SearchRequest) GetEntity

func (x *SearchRequest) GetEntity() string

func (*SearchRequest) GetFacetSpecs

func (x *SearchRequest) GetFacetSpecs() []*SearchRequest_FacetSpec

func (*SearchRequest) GetFilter

func (x *SearchRequest) GetFilter() string

func (*SearchRequest) GetLabels

func (x *SearchRequest) GetLabels() map[string]string

func (*SearchRequest) GetOffset

func (x *SearchRequest) GetOffset() int32

func (*SearchRequest) GetOrderBy

func (x *SearchRequest) GetOrderBy() string

func (*SearchRequest) GetPageCategories

func (x *SearchRequest) GetPageCategories() []string

func (*SearchRequest) GetPageSize

func (x *SearchRequest) GetPageSize() int32

func (*SearchRequest) GetPageToken

func (x *SearchRequest) GetPageToken() string

func (*SearchRequest) GetPersonalizationSpec

func (x *SearchRequest) GetPersonalizationSpec() *SearchRequest_PersonalizationSpec

func (*SearchRequest) GetPlacement

func (x *SearchRequest) GetPlacement() string

func (*SearchRequest) GetQuery

func (x *SearchRequest) GetQuery() string

func (*SearchRequest) GetQueryExpansionSpec

func (x *SearchRequest) GetQueryExpansionSpec() *SearchRequest_QueryExpansionSpec

func (*SearchRequest) GetSearchMode

func (x *SearchRequest) GetSearchMode() SearchRequest_SearchMode

func (*SearchRequest) GetSpellCorrectionSpec

func (x *SearchRequest) GetSpellCorrectionSpec() *SearchRequest_SpellCorrectionSpec

func (*SearchRequest) GetUserInfo

func (x *SearchRequest) GetUserInfo() *UserInfo

func (*SearchRequest) GetVariantRollupKeys

func (x *SearchRequest) GetVariantRollupKeys() []string

func (*SearchRequest) GetVisitorId

func (x *SearchRequest) GetVisitorId() string

func (*SearchRequest) ProtoMessage

func (*SearchRequest) ProtoMessage()

func (*SearchRequest) ProtoReflect

func (x *SearchRequest) ProtoReflect() protoreflect.Message

func (*SearchRequest) Reset

func (x *SearchRequest) Reset()

func (*SearchRequest) String

func (x *SearchRequest) String() string

SearchRequest_BoostSpec

type SearchRequest_BoostSpec struct {
	ConditionBoostSpecs []*SearchRequest_BoostSpec_ConditionBoostSpec `protobuf:"bytes,1,rep,name=condition_boost_specs,json=conditionBoostSpecs,proto3" json:"condition_boost_specs,omitempty"`

	SkipBoostSpecValidation *bool "" /* 141 byte string literal not displayed */

}

Boost specification to boost certain items.

func (*SearchRequest_BoostSpec) Descriptor

func (*SearchRequest_BoostSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_BoostSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec) GetConditionBoostSpecs

func (x *SearchRequest_BoostSpec) GetConditionBoostSpecs() []*SearchRequest_BoostSpec_ConditionBoostSpec

func (*SearchRequest_BoostSpec) GetSkipBoostSpecValidation

func (x *SearchRequest_BoostSpec) GetSkipBoostSpecValidation() bool

func (*SearchRequest_BoostSpec) ProtoMessage

func (*SearchRequest_BoostSpec) ProtoMessage()

func (*SearchRequest_BoostSpec) ProtoReflect

func (x *SearchRequest_BoostSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_BoostSpec) Reset

func (x *SearchRequest_BoostSpec) Reset()

func (*SearchRequest_BoostSpec) String

func (x *SearchRequest_BoostSpec) String() string

SearchRequest_BoostSpec_ConditionBoostSpec

type SearchRequest_BoostSpec_ConditionBoostSpec struct {

	// An expression which specifies a boost condition. The syntax and
	// supported fields are the same as a filter expression. See
	// [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter]
	// for detail syntax and limitations.
	//
	// Examples:
	//
	// * To boost products with product ID "product_1" or "product_2", and
	// color
	//
	//	"Red" or "Blue":
	//	  * (id: ANY("product_1", "product_2")) AND (colorFamilies:
	//	  ANY("Red","Blue"))
	Condition string `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"`
	// Strength of the condition boost, which should be in [-1, 1]. Negative
	// boost means demotion. Default is 0.0.
	//
	// Setting to 1.0 gives the item a big promotion. However, it does not
	// necessarily mean that the boosted item will be the top result at all
	// times, nor that other items will be excluded. Results could still be
	// shown even when none of them matches the condition. And results that
	// are significantly more relevant to the search query can still trump
	// your heavily favored but irrelevant items.
	//
	// Setting to -1.0 gives the item a big demotion. However, results that
	// are deeply relevant might still be shown. The item will have an
	// upstream battle to get a fairly high ranking, but it is not blocked out
	// completely.
	//
	// Setting to 0.0 means no boost applied. The boosting condition is
	// ignored.
	Boost float32 `protobuf:"fixed32,2,opt,name=boost,proto3" json:"boost,omitempty"`
	// contains filtered or unexported fields
}

Boost applies to products which match a condition.

func (*SearchRequest_BoostSpec_ConditionBoostSpec) Descriptor

func (*SearchRequest_BoostSpec_ConditionBoostSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_BoostSpec_ConditionBoostSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetBoost() float32

func (*SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) GetCondition() string

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoMessage()

func (*SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_BoostSpec_ConditionBoostSpec) Reset

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) Reset()

func (*SearchRequest_BoostSpec_ConditionBoostSpec) String

func (x *SearchRequest_BoostSpec_ConditionBoostSpec) String() string

SearchRequest_DynamicFacetSpec

type SearchRequest_DynamicFacetSpec struct {
	Mode SearchRequest_DynamicFacetSpec_Mode "" /* 130 byte string literal not displayed */

}

The specifications of dynamically generated facets.

func (*SearchRequest_DynamicFacetSpec) Descriptor

func (*SearchRequest_DynamicFacetSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_DynamicFacetSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_DynamicFacetSpec) GetMode

func (x *SearchRequest_DynamicFacetSpec) GetMode() SearchRequest_DynamicFacetSpec_Mode

func (*SearchRequest_DynamicFacetSpec) ProtoMessage

func (*SearchRequest_DynamicFacetSpec) ProtoMessage()

func (*SearchRequest_DynamicFacetSpec) ProtoReflect

func (x *SearchRequest_DynamicFacetSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_DynamicFacetSpec) Reset

func (x *SearchRequest_DynamicFacetSpec) Reset()

func (*SearchRequest_DynamicFacetSpec) String

func (x *SearchRequest_DynamicFacetSpec) String() string

SearchRequest_DynamicFacetSpec_Mode

type SearchRequest_DynamicFacetSpec_Mode int32

Enum to control DynamicFacet mode

SearchRequest_DynamicFacetSpec_MODE_UNSPECIFIED, SearchRequest_DynamicFacetSpec_DISABLED, SearchRequest_DynamicFacetSpec_ENABLED

const (
	// Default value.
	SearchRequest_DynamicFacetSpec_MODE_UNSPECIFIED SearchRequest_DynamicFacetSpec_Mode = 0
	// Disable Dynamic Facet.
	SearchRequest_DynamicFacetSpec_DISABLED SearchRequest_DynamicFacetSpec_Mode = 1
	// Automatic mode built by Google Retail Search.
	SearchRequest_DynamicFacetSpec_ENABLED SearchRequest_DynamicFacetSpec_Mode = 2
)

func (SearchRequest_DynamicFacetSpec_Mode) Descriptor

func (SearchRequest_DynamicFacetSpec_Mode) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_DynamicFacetSpec_Mode) Enum

func (x SearchRequest_DynamicFacetSpec_Mode) Enum() *SearchRequest_DynamicFacetSpec_Mode

func (SearchRequest_DynamicFacetSpec_Mode) EnumDescriptor

func (SearchRequest_DynamicFacetSpec_Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_DynamicFacetSpec_Mode.Descriptor instead.

func (SearchRequest_DynamicFacetSpec_Mode) Number

func (x SearchRequest_DynamicFacetSpec_Mode) Number() protoreflect.EnumNumber

func (SearchRequest_DynamicFacetSpec_Mode) String

func (x SearchRequest_DynamicFacetSpec_Mode) String() string

func (SearchRequest_DynamicFacetSpec_Mode) Type

func (SearchRequest_DynamicFacetSpec_Mode) Type() protoreflect.EnumType

SearchRequest_FacetSpec

type SearchRequest_FacetSpec struct {
	FacetKey *SearchRequest_FacetSpec_FacetKey `protobuf:"bytes,1,opt,name=facet_key,json=facetKey,proto3" json:"facet_key,omitempty"`

	Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`

	ExcludedFilterKeys []string `protobuf:"bytes,3,rep,name=excluded_filter_keys,json=excludedFilterKeys,proto3" json:"excluded_filter_keys,omitempty"`

	EnableDynamicPosition bool "" /* 127 byte string literal not displayed */

}

A facet specification to perform faceted search.

func (*SearchRequest_FacetSpec) Descriptor

func (*SearchRequest_FacetSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_FacetSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_FacetSpec) GetEnableDynamicPosition

func (x *SearchRequest_FacetSpec) GetEnableDynamicPosition() bool

func (*SearchRequest_FacetSpec) GetExcludedFilterKeys

func (x *SearchRequest_FacetSpec) GetExcludedFilterKeys() []string

func (*SearchRequest_FacetSpec) GetFacetKey

func (x *SearchRequest_FacetSpec) GetFacetKey() *SearchRequest_FacetSpec_FacetKey

func (*SearchRequest_FacetSpec) GetLimit

func (x *SearchRequest_FacetSpec) GetLimit() int32

func (*SearchRequest_FacetSpec) ProtoMessage

func (*SearchRequest_FacetSpec) ProtoMessage()

func (*SearchRequest_FacetSpec) ProtoReflect

func (x *SearchRequest_FacetSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_FacetSpec) Reset

func (x *SearchRequest_FacetSpec) Reset()

func (*SearchRequest_FacetSpec) String

func (x *SearchRequest_FacetSpec) String() string

SearchRequest_FacetSpec_FacetKey

type SearchRequest_FacetSpec_FacetKey struct {

	// Required. Supported textual and numerical facet keys in
	// [Product][google.cloud.retail.v2beta.Product] object, over which the
	// facet values are computed. Facet key is case-sensitive.
	//
	// Allowed facet keys when
	// [FacetKey.query][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.query]
	// is not specified:
	//
	// * textual_field =
	//   - "brands"
	//   - "categories"
	//   - "genders"
	//   - "ageGroups"
	//   - "availability"
	//   - "colorFamilies"
	//   - "colors"
	//   - "sizes"
	//   - "materials"
	//   - "patterns"
	//   - "conditions"
	//   - "attributes.key"
	//   - "pickupInStore"
	//   - "shipToStore"
	//   - "sameDayDelivery"
	//   - "nextDayDelivery"
	//   - "customFulfillment1"
	//   - "customFulfillment2"
	//   - "customFulfillment3"
	//   - "customFulfillment4"
	//   - "customFulfillment5"
	//   - "inventory(place_id,attributes.key)"
	//
	// * numerical_field =
	//   - "price"
	//   - "discount"
	//   - "rating"
	//   - "ratingCount"
	//   - "attributes.key"
	//   - "inventory(place_id,price)"
	//   - "inventory(place_id,original_price)"
	//   - "inventory(place_id,attributes.key)"
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Set only if values should be bucketized into intervals. Must be set
	// for facets with numerical values. Must not be set for facet with text
	// values. Maximum number of intervals is 40.
	//
	// For all numerical facet keys that appear in the list of products from
	// the catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are
	// computed from their distribution weekly. If the model assigns a high
	// score to a numerical facet key and its intervals are not specified in
	// the search request, these percentiles will become the bounds
	// for its intervals and will be returned in the response. If the
	// facet key intervals are specified in the request, then the specified
	// intervals will be returned instead.
	Intervals []*Interval `protobuf:"bytes,2,rep,name=intervals,proto3" json:"intervals,omitempty"`
	// Only get facet for the given restricted values. For example, when using
	// "pickupInStore" as key and set restricted values to
	// ["store123", "store456"], only facets for "store123" and "store456" are
	// returned. Only supported on predefined textual fields, custom textual
	// attributes and fulfillments. Maximum is 20.
	//
	// Must be set for the fulfillment facet keys:
	//
	// * pickupInStore
	//
	// * shipToStore
	//
	// * sameDayDelivery
	//
	// * nextDayDelivery
	//
	// * customFulfillment1
	//
	// * customFulfillment2
	//
	// * customFulfillment3
	//
	// * customFulfillment4
	//
	// * customFulfillment5
	RestrictedValues []string `protobuf:"bytes,3,rep,name=restricted_values,json=restrictedValues,proto3" json:"restricted_values,omitempty"`
	// Only get facet values that start with the given string prefix. For
	// example, suppose "categories" has three values "Women > Shoe",
	// "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the
	// "categories" facet will give only "Women > Shoe" and "Women > Dress".
	// Only supported on textual fields. Maximum is 10.
	Prefixes []string `protobuf:"bytes,8,rep,name=prefixes,proto3" json:"prefixes,omitempty"`
	// Only get facet values that contains the given strings. For example,
	// suppose "categories" has three values "Women > Shoe",
	// "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the
	// "categories" facet will give only "Women > Shoe" and "Men > Shoe".
	// Only supported on textual fields. Maximum is 10.
	Contains []string `protobuf:"bytes,9,rep,name=contains,proto3" json:"contains,omitempty"`
	// True to make facet keys case insensitive when getting faceting
	// values with prefixes or contains; false otherwise.
	CaseInsensitive bool `protobuf:"varint,10,opt,name=case_insensitive,json=caseInsensitive,proto3" json:"case_insensitive,omitempty"`
	// The order in which
	// [SearchResponse.Facet.values][google.cloud.retail.v2beta.SearchResponse.Facet.values]
	// are returned.
	//
	// Allowed values are:
	//
	// * "count desc", which means order by
	// [SearchResponse.Facet.values.count][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.count]
	// descending.
	//
	// * "value desc", which means order by
	// [SearchResponse.Facet.values.value][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.value]
	// descending.
	//
	//	Only applies to textual facets.
	//
	// If not set, textual values are sorted in [natural
	// order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
	// intervals are sorted in the order given by
	// [FacetSpec.FacetKey.intervals][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.intervals];
	// [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids]
	// are sorted in the order given by
	// [FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.restricted_values].
	OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// The query that is used to compute facet for the given facet key.
	// When provided, it will override the default behavior of facet
	// computation. The query syntax is the same as a filter expression. See
	// [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter]
	// for detail syntax and limitations. Notice that there is no limitation
	// on
	// [FacetKey.key][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.key]
	// when query is specified.
	//
	// In the response,
	// [SearchResponse.Facet.values.value][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.value]
	// will be always "1" and
	// [SearchResponse.Facet.values.count][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.count]
	// will be the number of results that match the query.
	//
	// For example, you can set a customized facet for "shipToStore",
	// where
	// [FacetKey.key][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.key]
	// is "customizedShipToStore", and
	// [FacetKey.query][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.query]
	// is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")".
	// Then the facet will count the products that are both in stock and ship
	// to store "123".
	Query string `protobuf:"bytes,5,opt,name=query,proto3" json:"query,omitempty"`
	// Returns the min and max value for each numerical facet intervals.
	// Ignored for textual facets.
	ReturnMinMax bool `protobuf:"varint,11,opt,name=return_min_max,json=returnMinMax,proto3" json:"return_min_max,omitempty"`
	// contains filtered or unexported fields
}

Specifies how a facet is computed.

func (*SearchRequest_FacetSpec_FacetKey) Descriptor

func (*SearchRequest_FacetSpec_FacetKey) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_FacetSpec_FacetKey.ProtoReflect.Descriptor instead.

func (*SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive

func (x *SearchRequest_FacetSpec_FacetKey) GetCaseInsensitive() bool

func (*SearchRequest_FacetSpec_FacetKey) GetContains

func (x *SearchRequest_FacetSpec_FacetKey) GetContains() []string

func (*SearchRequest_FacetSpec_FacetKey) GetIntervals

func (x *SearchRequest_FacetSpec_FacetKey) GetIntervals() []*Interval

func (*SearchRequest_FacetSpec_FacetKey) GetKey

func (x *SearchRequest_FacetSpec_FacetKey) GetKey() string

func (*SearchRequest_FacetSpec_FacetKey) GetOrderBy

func (x *SearchRequest_FacetSpec_FacetKey) GetOrderBy() string

func (*SearchRequest_FacetSpec_FacetKey) GetPrefixes

func (x *SearchRequest_FacetSpec_FacetKey) GetPrefixes() []string

func (*SearchRequest_FacetSpec_FacetKey) GetQuery

func (x *SearchRequest_FacetSpec_FacetKey) GetQuery() string

func (*SearchRequest_FacetSpec_FacetKey) GetRestrictedValues

func (x *SearchRequest_FacetSpec_FacetKey) GetRestrictedValues() []string

func (*SearchRequest_FacetSpec_FacetKey) GetReturnMinMax

func (x *SearchRequest_FacetSpec_FacetKey) GetReturnMinMax() bool

func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage

func (*SearchRequest_FacetSpec_FacetKey) ProtoMessage()

func (*SearchRequest_FacetSpec_FacetKey) ProtoReflect

func (x *SearchRequest_FacetSpec_FacetKey) ProtoReflect() protoreflect.Message

func (*SearchRequest_FacetSpec_FacetKey) Reset

func (x *SearchRequest_FacetSpec_FacetKey) Reset()

func (*SearchRequest_FacetSpec_FacetKey) String

func (x *SearchRequest_FacetSpec_FacetKey) String() string

SearchRequest_PersonalizationSpec

type SearchRequest_PersonalizationSpec struct {
	Mode SearchRequest_PersonalizationSpec_Mode "" /* 133 byte string literal not displayed */

}

The specification for personalization.

func (*SearchRequest_PersonalizationSpec) Descriptor

func (*SearchRequest_PersonalizationSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_PersonalizationSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_PersonalizationSpec) GetMode

func (x *SearchRequest_PersonalizationSpec) GetMode() SearchRequest_PersonalizationSpec_Mode

func (*SearchRequest_PersonalizationSpec) ProtoMessage

func (*SearchRequest_PersonalizationSpec) ProtoMessage()

func (*SearchRequest_PersonalizationSpec) ProtoReflect

func (x *SearchRequest_PersonalizationSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_PersonalizationSpec) Reset

func (x *SearchRequest_PersonalizationSpec) Reset()

func (*SearchRequest_PersonalizationSpec) String

func (x *SearchRequest_PersonalizationSpec) String() string

SearchRequest_PersonalizationSpec_Mode

type SearchRequest_PersonalizationSpec_Mode int32

The personalization mode of each search request.

SearchRequest_PersonalizationSpec_MODE_UNSPECIFIED, SearchRequest_PersonalizationSpec_AUTO, SearchRequest_PersonalizationSpec_DISABLED

const (
	// Default value. In this case, server behavior defaults to
	// [Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.Mode.AUTO].
	SearchRequest_PersonalizationSpec_MODE_UNSPECIFIED SearchRequest_PersonalizationSpec_Mode = 0
	// Let CRS decide whether to use personalization based on quality of user
	// event data.
	SearchRequest_PersonalizationSpec_AUTO SearchRequest_PersonalizationSpec_Mode = 1
	// Disable personalization.
	SearchRequest_PersonalizationSpec_DISABLED SearchRequest_PersonalizationSpec_Mode = 2
)

func (SearchRequest_PersonalizationSpec_Mode) Descriptor

func (SearchRequest_PersonalizationSpec_Mode) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_PersonalizationSpec_Mode) Enum

func (x SearchRequest_PersonalizationSpec_Mode) Enum() *SearchRequest_PersonalizationSpec_Mode

func (SearchRequest_PersonalizationSpec_Mode) EnumDescriptor

func (SearchRequest_PersonalizationSpec_Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_PersonalizationSpec_Mode.Descriptor instead.

func (SearchRequest_PersonalizationSpec_Mode) Number

func (x SearchRequest_PersonalizationSpec_Mode) Number() protoreflect.EnumNumber

func (SearchRequest_PersonalizationSpec_Mode) String

func (x SearchRequest_PersonalizationSpec_Mode) String() string

func (SearchRequest_PersonalizationSpec_Mode) Type

func (SearchRequest_PersonalizationSpec_Mode) Type() protoreflect.EnumType

SearchRequest_QueryExpansionSpec

type SearchRequest_QueryExpansionSpec struct {
	Condition SearchRequest_QueryExpansionSpec_Condition "" /* 147 byte string literal not displayed */

	PinUnexpandedResults bool `protobuf:"varint,2,opt,name=pin_unexpanded_results,json=pinUnexpandedResults,proto3" json:"pin_unexpanded_results,omitempty"`

}

Specification to determine under which conditions query expansion should occur.

func (*SearchRequest_QueryExpansionSpec) Descriptor

func (*SearchRequest_QueryExpansionSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_QueryExpansionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_QueryExpansionSpec) GetCondition

func (x *SearchRequest_QueryExpansionSpec) GetCondition() SearchRequest_QueryExpansionSpec_Condition

func (*SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults

func (x *SearchRequest_QueryExpansionSpec) GetPinUnexpandedResults() bool

func (*SearchRequest_QueryExpansionSpec) ProtoMessage

func (*SearchRequest_QueryExpansionSpec) ProtoMessage()

func (*SearchRequest_QueryExpansionSpec) ProtoReflect

func (x *SearchRequest_QueryExpansionSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_QueryExpansionSpec) Reset

func (x *SearchRequest_QueryExpansionSpec) Reset()

func (*SearchRequest_QueryExpansionSpec) String

func (x *SearchRequest_QueryExpansionSpec) String() string

SearchRequest_QueryExpansionSpec_Condition

type SearchRequest_QueryExpansionSpec_Condition int32

Enum describing under which condition query expansion should occur.

SearchRequest_QueryExpansionSpec_CONDITION_UNSPECIFIED, SearchRequest_QueryExpansionSpec_DISABLED, SearchRequest_QueryExpansionSpec_AUTO

const (
	// Unspecified query expansion condition. In this case, server behavior
	// defaults to
	// [Condition.DISABLED][google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
	SearchRequest_QueryExpansionSpec_CONDITION_UNSPECIFIED SearchRequest_QueryExpansionSpec_Condition = 0
	// Disabled query expansion. Only the exact search query is used, even if
	// [SearchResponse.total_size][google.cloud.retail.v2beta.SearchResponse.total_size]
	// is zero.
	SearchRequest_QueryExpansionSpec_DISABLED SearchRequest_QueryExpansionSpec_Condition = 1
	// Automatic query expansion built by Google Retail Search.
	SearchRequest_QueryExpansionSpec_AUTO SearchRequest_QueryExpansionSpec_Condition = 3
)

func (SearchRequest_QueryExpansionSpec_Condition) Descriptor

func (SearchRequest_QueryExpansionSpec_Condition) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_QueryExpansionSpec_Condition) Enum

func (x SearchRequest_QueryExpansionSpec_Condition) Enum() *SearchRequest_QueryExpansionSpec_Condition

func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor

func (SearchRequest_QueryExpansionSpec_Condition) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_QueryExpansionSpec_Condition.Descriptor instead.

func (SearchRequest_QueryExpansionSpec_Condition) Number

func (x SearchRequest_QueryExpansionSpec_Condition) Number() protoreflect.EnumNumber

func (SearchRequest_QueryExpansionSpec_Condition) String

func (x SearchRequest_QueryExpansionSpec_Condition) String() string

func (SearchRequest_QueryExpansionSpec_Condition) Type

func (SearchRequest_QueryExpansionSpec_Condition) Type() protoreflect.EnumType

SearchRequest_SearchMode

type SearchRequest_SearchMode int32

The search mode of each search request.

SearchRequest_SEARCH_MODE_UNSPECIFIED, SearchRequest_PRODUCT_SEARCH_ONLY, SearchRequest_FACETED_SEARCH_ONLY

const (
	// Default value. In this case both product search and faceted search will
	// be performed. Both
	// [SearchResponse.SearchResult][google.cloud.retail.v2beta.SearchResponse.SearchResult]
	// and
	// [SearchResponse.Facet][google.cloud.retail.v2beta.SearchResponse.Facet]
	// will be returned.
	SearchRequest_SEARCH_MODE_UNSPECIFIED SearchRequest_SearchMode = 0
	// Only product search will be performed. The faceted search will be
	// disabled.
	//
	// Only
	// [SearchResponse.SearchResult][google.cloud.retail.v2beta.SearchResponse.SearchResult]
	// will be returned.
	// [SearchResponse.Facet][google.cloud.retail.v2beta.SearchResponse.Facet]
	// will not be returned, even if
	// [SearchRequest.facet_specs][google.cloud.retail.v2beta.SearchRequest.facet_specs]
	// or
	// [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec]
	// is set.
	SearchRequest_PRODUCT_SEARCH_ONLY SearchRequest_SearchMode = 1
	// Only faceted search will be performed. The product search will be
	// disabled.
	//
	// When in this mode, one or both of
	// [SearchRequest.facet_specs][google.cloud.retail.v2beta.SearchRequest.facet_specs]
	// and
	// [SearchRequest.dynamic_facet_spec][google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec]
	// should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only
	// [SearchResponse.Facet][google.cloud.retail.v2beta.SearchResponse.Facet]
	// will be returned.
	// [SearchResponse.SearchResult][google.cloud.retail.v2beta.SearchResponse.SearchResult]
	// will not be returned.
	SearchRequest_FACETED_SEARCH_ONLY SearchRequest_SearchMode = 2
)

func (SearchRequest_SearchMode) Descriptor

func (SearchRequest_SearchMode) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_SearchMode) Enum

func (x SearchRequest_SearchMode) Enum() *SearchRequest_SearchMode

func (SearchRequest_SearchMode) EnumDescriptor

func (SearchRequest_SearchMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_SearchMode.Descriptor instead.

func (SearchRequest_SearchMode) Number

func (x SearchRequest_SearchMode) Number() protoreflect.EnumNumber

func (SearchRequest_SearchMode) String

func (x SearchRequest_SearchMode) String() string

func (SearchRequest_SearchMode) Type

func (SearchRequest_SearchMode) Type() protoreflect.EnumType

SearchRequest_SpellCorrectionSpec

type SearchRequest_SpellCorrectionSpec struct {
	Mode SearchRequest_SpellCorrectionSpec_Mode "" /* 133 byte string literal not displayed */

}

The specification for query spell correction.

func (*SearchRequest_SpellCorrectionSpec) Descriptor

func (*SearchRequest_SpellCorrectionSpec) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest_SpellCorrectionSpec.ProtoReflect.Descriptor instead.

func (*SearchRequest_SpellCorrectionSpec) GetMode

func (x *SearchRequest_SpellCorrectionSpec) GetMode() SearchRequest_SpellCorrectionSpec_Mode

func (*SearchRequest_SpellCorrectionSpec) ProtoMessage

func (*SearchRequest_SpellCorrectionSpec) ProtoMessage()

func (*SearchRequest_SpellCorrectionSpec) ProtoReflect

func (x *SearchRequest_SpellCorrectionSpec) ProtoReflect() protoreflect.Message

func (*SearchRequest_SpellCorrectionSpec) Reset

func (x *SearchRequest_SpellCorrectionSpec) Reset()

func (*SearchRequest_SpellCorrectionSpec) String

func (x *SearchRequest_SpellCorrectionSpec) String() string

SearchRequest_SpellCorrectionSpec_Mode

type SearchRequest_SpellCorrectionSpec_Mode int32

Enum describing under which mode spell correction should occur.

SearchRequest_SpellCorrectionSpec_MODE_UNSPECIFIED, SearchRequest_SpellCorrectionSpec_SUGGESTION_ONLY, SearchRequest_SpellCorrectionSpec_AUTO

const (
	// Unspecified spell correction mode. In this case, server behavior
	// defaults to
	// [Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
	SearchRequest_SpellCorrectionSpec_MODE_UNSPECIFIED SearchRequest_SpellCorrectionSpec_Mode = 0
	// Google Retail Search will try to find a spell suggestion if there
	// is any and put in the
	// [SearchResponse.corrected_query][google.cloud.retail.v2beta.SearchResponse.corrected_query].
	// The spell suggestion will not be used as the search query.
	SearchRequest_SpellCorrectionSpec_SUGGESTION_ONLY SearchRequest_SpellCorrectionSpec_Mode = 1
	// Automatic spell correction built by Google Retail Search. Search will
	// be based on the corrected query if found.
	SearchRequest_SpellCorrectionSpec_AUTO SearchRequest_SpellCorrectionSpec_Mode = 2
)

func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor

func (SearchRequest_SpellCorrectionSpec_Mode) Descriptor() protoreflect.EnumDescriptor

func (SearchRequest_SpellCorrectionSpec_Mode) Enum

func (x SearchRequest_SpellCorrectionSpec_Mode) Enum() *SearchRequest_SpellCorrectionSpec_Mode

func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor

func (SearchRequest_SpellCorrectionSpec_Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchRequest_SpellCorrectionSpec_Mode.Descriptor instead.

func (SearchRequest_SpellCorrectionSpec_Mode) Number

func (x SearchRequest_SpellCorrectionSpec_Mode) Number() protoreflect.EnumNumber

func (SearchRequest_SpellCorrectionSpec_Mode) String

func (x SearchRequest_SpellCorrectionSpec_Mode) String() string

func (SearchRequest_SpellCorrectionSpec_Mode) Type

func (SearchRequest_SpellCorrectionSpec_Mode) Type() protoreflect.EnumType

SearchResponse

type SearchResponse struct {
	Results []*SearchResponse_SearchResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`

	Facets []*SearchResponse_Facet `protobuf:"bytes,2,rep,name=facets,proto3" json:"facets,omitempty"`

	TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`

	CorrectedQuery string `protobuf:"bytes,4,opt,name=corrected_query,json=correctedQuery,proto3" json:"corrected_query,omitempty"`

	AttributionToken string `protobuf:"bytes,5,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`

	NextPageToken string `protobuf:"bytes,6,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`

	QueryExpansionInfo *SearchResponse_QueryExpansionInfo `protobuf:"bytes,7,opt,name=query_expansion_info,json=queryExpansionInfo,proto3" json:"query_expansion_info,omitempty"`

	RedirectUri string `protobuf:"bytes,10,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`

	AppliedControls []string `protobuf:"bytes,12,rep,name=applied_controls,json=appliedControls,proto3" json:"applied_controls,omitempty"`

	InvalidConditionBoostSpecs []*SearchRequest_BoostSpec_ConditionBoostSpec "" /* 144 byte string literal not displayed */

	ExperimentInfo []*ExperimentInfo `protobuf:"bytes,17,rep,name=experiment_info,json=experimentInfo,proto3" json:"experiment_info,omitempty"`

}

Response message for [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] method.

func (*SearchResponse) Descriptor

func (*SearchResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetAppliedControls

func (x *SearchResponse) GetAppliedControls() []string

func (*SearchResponse) GetAttributionToken

func (x *SearchResponse) GetAttributionToken() string

func (*SearchResponse) GetCorrectedQuery

func (x *SearchResponse) GetCorrectedQuery() string

func (*SearchResponse) GetExperimentInfo

func (x *SearchResponse) GetExperimentInfo() []*ExperimentInfo

func (*SearchResponse) GetFacets

func (x *SearchResponse) GetFacets() []*SearchResponse_Facet

func (*SearchResponse) GetInvalidConditionBoostSpecs

func (x *SearchResponse) GetInvalidConditionBoostSpecs() []*SearchRequest_BoostSpec_ConditionBoostSpec

func (*SearchResponse) GetNextPageToken

func (x *SearchResponse) GetNextPageToken() string

func (*SearchResponse) GetQueryExpansionInfo

func (x *SearchResponse) GetQueryExpansionInfo() *SearchResponse_QueryExpansionInfo

func (*SearchResponse) GetRedirectUri

func (x *SearchResponse) GetRedirectUri() string

func (*SearchResponse) GetResults

func (x *SearchResponse) GetResults() []*SearchResponse_SearchResult

func (*SearchResponse) GetTotalSize

func (x *SearchResponse) GetTotalSize() int32

func (*SearchResponse) ProtoMessage

func (*SearchResponse) ProtoMessage()

func (*SearchResponse) ProtoReflect

func (x *SearchResponse) ProtoReflect() protoreflect.Message

func (*SearchResponse) Reset

func (x *SearchResponse) Reset()

func (*SearchResponse) String

func (x *SearchResponse) String() string

SearchResponse_Facet

type SearchResponse_Facet struct {

	// The key for this facet. E.g., "colorFamilies" or "price" or
	// "attributes.attr1".
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// The facet values for this field.
	Values []*SearchResponse_Facet_FacetValue `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
	// Whether the facet is dynamically generated.
	DynamicFacet bool `protobuf:"varint,3,opt,name=dynamic_facet,json=dynamicFacet,proto3" json:"dynamic_facet,omitempty"`
	// contains filtered or unexported fields
}

A facet result.

func (*SearchResponse_Facet) Descriptor

func (*SearchResponse_Facet) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Facet.ProtoReflect.Descriptor instead.

func (*SearchResponse_Facet) GetDynamicFacet

func (x *SearchResponse_Facet) GetDynamicFacet() bool

func (*SearchResponse_Facet) GetKey

func (x *SearchResponse_Facet) GetKey() string

func (*SearchResponse_Facet) GetValues

func (x *SearchResponse_Facet) GetValues() []*SearchResponse_Facet_FacetValue

func (*SearchResponse_Facet) ProtoMessage

func (*SearchResponse_Facet) ProtoMessage()

func (*SearchResponse_Facet) ProtoReflect

func (x *SearchResponse_Facet) ProtoReflect() protoreflect.Message

func (*SearchResponse_Facet) Reset

func (x *SearchResponse_Facet) Reset()

func (*SearchResponse_Facet) String

func (x *SearchResponse_Facet) String() string

SearchResponse_Facet_FacetValue

type SearchResponse_Facet_FacetValue struct {

	// A facet value which contains values.
	//
	// Types that are assignable to FacetValue:
	//
	//	*SearchResponse_Facet_FacetValue_Value
	//	*SearchResponse_Facet_FacetValue_Interval
	FacetValue isSearchResponse_Facet_FacetValue_FacetValue `protobuf_oneof:"facet_value"`
	// Number of items that have this facet value.
	Count int64 `protobuf:"varint,3,opt,name=count,proto3" json:"count,omitempty"`
	// The minimum value in the
	// [FacetValue.interval][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.interval].
	// Only supported on numerical facets and returned if
	// [SearchRequest.FacetSpec.FacetKey.return_min_max][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.return_min_max]
	// is true.
	MinValue float64 `protobuf:"fixed64,5,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	// The maximum value in the
	// [FacetValue.interval][google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue.interval].
	// Only supported on numerical facets and returned if
	// [SearchRequest.FacetSpec.FacetKey.return_min_max][google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey.return_min_max]
	// is true.
	MaxValue float64 `protobuf:"fixed64,6,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	// contains filtered or unexported fields
}

A facet value which contains value names and their count.

func (*SearchResponse_Facet_FacetValue) Descriptor

func (*SearchResponse_Facet_FacetValue) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Facet_FacetValue.ProtoReflect.Descriptor instead.

func (*SearchResponse_Facet_FacetValue) GetCount

func (x *SearchResponse_Facet_FacetValue) GetCount() int64

func (*SearchResponse_Facet_FacetValue) GetFacetValue

func (m *SearchResponse_Facet_FacetValue) GetFacetValue() isSearchResponse_Facet_FacetValue_FacetValue

func (*SearchResponse_Facet_FacetValue) GetInterval

func (x *SearchResponse_Facet_FacetValue) GetInterval() *Interval

func (*SearchResponse_Facet_FacetValue) GetMaxValue

func (x *SearchResponse_Facet_FacetValue) GetMaxValue() float64

func (*SearchResponse_Facet_FacetValue) GetMinValue

func (x *SearchResponse_Facet_FacetValue) GetMinValue() float64

func (*SearchResponse_Facet_FacetValue) GetValue

func (x *SearchResponse_Facet_FacetValue) GetValue() string

func (*SearchResponse_Facet_FacetValue) ProtoMessage

func (*SearchResponse_Facet_FacetValue) ProtoMessage()

func (*SearchResponse_Facet_FacetValue) ProtoReflect

func (x *SearchResponse_Facet_FacetValue) ProtoReflect() protoreflect.Message

func (*SearchResponse_Facet_FacetValue) Reset

func (x *SearchResponse_Facet_FacetValue) Reset()

func (*SearchResponse_Facet_FacetValue) String

func (x *SearchResponse_Facet_FacetValue) String() string

SearchResponse_Facet_FacetValue_Interval

type SearchResponse_Facet_FacetValue_Interval struct {
	// Interval value for a facet, such as [10, 20) for facet "price".
	Interval *Interval `protobuf:"bytes,2,opt,name=interval,proto3,oneof"`
}

SearchResponse_Facet_FacetValue_Value

type SearchResponse_Facet_FacetValue_Value struct {
	// Text value of a facet, such as "Black" for facet "colorFamilies".
	Value string `protobuf:"bytes,1,opt,name=value,proto3,oneof"`
}

SearchResponse_QueryExpansionInfo

type SearchResponse_QueryExpansionInfo struct {

	// Bool describing whether query expansion has occurred.
	ExpandedQuery bool `protobuf:"varint,1,opt,name=expanded_query,json=expandedQuery,proto3" json:"expanded_query,omitempty"`
	// Number of pinned results. This field will only be set when expansion
	// happens and
	// [SearchRequest.QueryExpansionSpec.pin_unexpanded_results][google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec.pin_unexpanded_results]
	// is set to true.
	PinnedResultCount int64 `protobuf:"varint,2,opt,name=pinned_result_count,json=pinnedResultCount,proto3" json:"pinned_result_count,omitempty"`
	// contains filtered or unexported fields
}

Information describing query expansion including whether expansion has occurred.

func (*SearchResponse_QueryExpansionInfo) Descriptor

func (*SearchResponse_QueryExpansionInfo) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_QueryExpansionInfo.ProtoReflect.Descriptor instead.

func (*SearchResponse_QueryExpansionInfo) GetExpandedQuery

func (x *SearchResponse_QueryExpansionInfo) GetExpandedQuery() bool

func (*SearchResponse_QueryExpansionInfo) GetPinnedResultCount

func (x *SearchResponse_QueryExpansionInfo) GetPinnedResultCount() int64

func (*SearchResponse_QueryExpansionInfo) ProtoMessage

func (*SearchResponse_QueryExpansionInfo) ProtoMessage()

func (*SearchResponse_QueryExpansionInfo) ProtoReflect

func (x *SearchResponse_QueryExpansionInfo) ProtoReflect() protoreflect.Message

func (*SearchResponse_QueryExpansionInfo) Reset

func (x *SearchResponse_QueryExpansionInfo) Reset()

func (*SearchResponse_QueryExpansionInfo) String

func (x *SearchResponse_QueryExpansionInfo) String() string

SearchResponse_SearchResult

type SearchResponse_SearchResult struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`

	Product *Product `protobuf:"bytes,2,opt,name=product,proto3" json:"product,omitempty"`

	MatchingVariantCount int32 `protobuf:"varint,3,opt,name=matching_variant_count,json=matchingVariantCount,proto3" json:"matching_variant_count,omitempty"`

	MatchingVariantFields map[string]*fieldmaskpb.FieldMask "" /* 214 byte string literal not displayed */

	VariantRollupValues map[string]*structpb.Value "" /* 208 byte string literal not displayed */

	PersonalLabels []string `protobuf:"bytes,7,rep,name=personal_labels,json=personalLabels,proto3" json:"personal_labels,omitempty"`

}

Represents the search results.

func (*SearchResponse_SearchResult) Descriptor

func (*SearchResponse_SearchResult) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_SearchResult.ProtoReflect.Descriptor instead.

func (*SearchResponse_SearchResult) GetId

func (x *SearchResponse_SearchResult) GetId() string

func (*SearchResponse_SearchResult) GetMatchingVariantCount

func (x *SearchResponse_SearchResult) GetMatchingVariantCount() int32

func (*SearchResponse_SearchResult) GetMatchingVariantFields

func (x *SearchResponse_SearchResult) GetMatchingVariantFields() map[string]*fieldmaskpb.FieldMask

func (*SearchResponse_SearchResult) GetPersonalLabels

func (x *SearchResponse_SearchResult) GetPersonalLabels() []string

func (*SearchResponse_SearchResult) GetProduct

func (x *SearchResponse_SearchResult) GetProduct() *Product

func (*SearchResponse_SearchResult) GetVariantRollupValues

func (x *SearchResponse_SearchResult) GetVariantRollupValues() map[string]*structpb.Value

func (*SearchResponse_SearchResult) ProtoMessage

func (*SearchResponse_SearchResult) ProtoMessage()

func (*SearchResponse_SearchResult) ProtoReflect

func (x *SearchResponse_SearchResult) ProtoReflect() protoreflect.Message

func (*SearchResponse_SearchResult) Reset

func (x *SearchResponse_SearchResult) Reset()

func (*SearchResponse_SearchResult) String

func (x *SearchResponse_SearchResult) String() string

SearchServiceClient

type SearchServiceClient interface {
	// 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.
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchResponse, error)
}

SearchServiceClient is the client API for SearchService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewSearchServiceClient

func NewSearchServiceClient(cc grpc.ClientConnInterface) SearchServiceClient

SearchServiceServer

type SearchServiceServer interface {
	// 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.
	Search(context.Context, *SearchRequest) (*SearchResponse, error)
}

SearchServiceServer is the server API for SearchService service.

SearchSolutionUseCase

type SearchSolutionUseCase int32

The use case of Cloud Retail Search.

SearchSolutionUseCase_SEARCH_SOLUTION_USE_CASE_UNSPECIFIED, SearchSolutionUseCase_SEARCH_SOLUTION_USE_CASE_SEARCH, SearchSolutionUseCase_SEARCH_SOLUTION_USE_CASE_BROWSE

const (
	// The value when it's unspecified. In this case, server behavior defaults to
	// [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2beta.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH].
	SearchSolutionUseCase_SEARCH_SOLUTION_USE_CASE_UNSPECIFIED SearchSolutionUseCase = 0
	// Search use case. Expects the traffic has a non-empty
	// [query][google.cloud.retail.v2beta.SearchRequest.query].
	SearchSolutionUseCase_SEARCH_SOLUTION_USE_CASE_SEARCH SearchSolutionUseCase = 1
	// Browse use case. Expects the traffic has an empty
	// [query][google.cloud.retail.v2beta.SearchRequest.query].
	SearchSolutionUseCase_SEARCH_SOLUTION_USE_CASE_BROWSE SearchSolutionUseCase = 2
)

func (SearchSolutionUseCase) Descriptor

func (SearchSolutionUseCase) Descriptor() protoreflect.EnumDescriptor

func (SearchSolutionUseCase) Enum

func (x SearchSolutionUseCase) Enum() *SearchSolutionUseCase

func (SearchSolutionUseCase) EnumDescriptor

func (SearchSolutionUseCase) EnumDescriptor() ([]byte, []int)

Deprecated: Use SearchSolutionUseCase.Descriptor instead.

func (SearchSolutionUseCase) Number

func (x SearchSolutionUseCase) Number() protoreflect.EnumNumber

func (SearchSolutionUseCase) String

func (x SearchSolutionUseCase) String() string

func (SearchSolutionUseCase) Type

func (SearchSolutionUseCase) Type() protoreflect.EnumType

ServingConfig

type ServingConfig struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`

	ModelId string `protobuf:"bytes,3,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`

	PriceRerankingLevel string `protobuf:"bytes,4,opt,name=price_reranking_level,json=priceRerankingLevel,proto3" json:"price_reranking_level,omitempty"`

	FacetControlIds []string `protobuf:"bytes,5,rep,name=facet_control_ids,json=facetControlIds,proto3" json:"facet_control_ids,omitempty"`

	DynamicFacetSpec *SearchRequest_DynamicFacetSpec `protobuf:"bytes,6,opt,name=dynamic_facet_spec,json=dynamicFacetSpec,proto3" json:"dynamic_facet_spec,omitempty"`

	BoostControlIds []string `protobuf:"bytes,7,rep,name=boost_control_ids,json=boostControlIds,proto3" json:"boost_control_ids,omitempty"`

	FilterControlIds []string `protobuf:"bytes,9,rep,name=filter_control_ids,json=filterControlIds,proto3" json:"filter_control_ids,omitempty"`

	RedirectControlIds []string `protobuf:"bytes,10,rep,name=redirect_control_ids,json=redirectControlIds,proto3" json:"redirect_control_ids,omitempty"`

	TwowaySynonymsControlIds []string "" /* 138 byte string literal not displayed */

	OnewaySynonymsControlIds []string "" /* 138 byte string literal not displayed */

	DoNotAssociateControlIds []string "" /* 140 byte string literal not displayed */

	ReplacementControlIds []string "" /* 127 byte string literal not displayed */

	IgnoreControlIds []string `protobuf:"bytes,15,rep,name=ignore_control_ids,json=ignoreControlIds,proto3" json:"ignore_control_ids,omitempty"`

	DiversityLevel string `protobuf:"bytes,8,opt,name=diversity_level,json=diversityLevel,proto3" json:"diversity_level,omitempty"`

	DiversityType ServingConfig_DiversityType "" /* 162 byte string literal not displayed */

	EnableCategoryFilterLevel string "" /* 141 byte string literal not displayed */

	PersonalizationSpec *SearchRequest_PersonalizationSpec `protobuf:"bytes,21,opt,name=personalization_spec,json=personalizationSpec,proto3" json:"personalization_spec,omitempty"`

	SolutionTypes []SolutionType "" /* 154 byte string literal not displayed */

}

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).

func (*ServingConfig) Descriptor

func (*ServingConfig) Descriptor() ([]byte, []int)

Deprecated: Use ServingConfig.ProtoReflect.Descriptor instead.

func (*ServingConfig) GetBoostControlIds

func (x *ServingConfig) GetBoostControlIds() []string

func (*ServingConfig) GetDisplayName

func (x *ServingConfig) GetDisplayName() string

func (*ServingConfig) GetDiversityLevel

func (x *ServingConfig) GetDiversityLevel() string

func (*ServingConfig) GetDiversityType

func (x *ServingConfig) GetDiversityType() ServingConfig_DiversityType

func (*ServingConfig) GetDoNotAssociateControlIds

func (x *ServingConfig) GetDoNotAssociateControlIds() []string

func (*ServingConfig) GetDynamicFacetSpec

func (x *ServingConfig) GetDynamicFacetSpec() *SearchRequest_DynamicFacetSpec

func (*ServingConfig) GetEnableCategoryFilterLevel

func (x *ServingConfig) GetEnableCategoryFilterLevel() string

func (*ServingConfig) GetFacetControlIds

func (x *ServingConfig) GetFacetControlIds() []string

func (*ServingConfig) GetFilterControlIds

func (x *ServingConfig) GetFilterControlIds() []string

func (*ServingConfig) GetIgnoreControlIds

func (x *ServingConfig) GetIgnoreControlIds() []string

func (*ServingConfig) GetModelId

func (x *ServingConfig) GetModelId() string

func (*ServingConfig) GetName

func (x *ServingConfig) GetName() string

func (*ServingConfig) GetOnewaySynonymsControlIds

func (x *ServingConfig) GetOnewaySynonymsControlIds() []string

func (*ServingConfig) GetPersonalizationSpec

func (x *ServingConfig) GetPersonalizationSpec() *SearchRequest_PersonalizationSpec

func (*ServingConfig) GetPriceRerankingLevel

func (x *ServingConfig) GetPriceRerankingLevel() string

func (*ServingConfig) GetRedirectControlIds

func (x *ServingConfig) GetRedirectControlIds() []string

func (*ServingConfig) GetReplacementControlIds

func (x *ServingConfig) GetReplacementControlIds() []string

func (*ServingConfig) GetSolutionTypes

func (x *ServingConfig) GetSolutionTypes() []SolutionType

func (*ServingConfig) GetTwowaySynonymsControlIds

func (x *ServingConfig) GetTwowaySynonymsControlIds() []string

func (*ServingConfig) ProtoMessage

func (*ServingConfig) ProtoMessage()

func (*ServingConfig) ProtoReflect

func (x *ServingConfig) ProtoReflect() protoreflect.Message

func (*ServingConfig) Reset

func (x *ServingConfig) Reset()

func (*ServingConfig) String

func (x *ServingConfig) String() string

ServingConfigServiceClient

type ServingConfigServiceClient interface {
	// Creates a ServingConfig.
	//
	// A maximum of 100 [ServingConfig][google.cloud.retail.v2beta.ServingConfig]s
	// are allowed in a [Catalog][google.cloud.retail.v2beta.Catalog], otherwise
	// a FAILED_PRECONDITION error is returned.
	CreateServingConfig(ctx context.Context, in *CreateServingConfigRequest, opts ...grpc.CallOption) (*ServingConfig, error)
	// Deletes a ServingConfig.
	//
	// Returns a NotFound error if the ServingConfig does not exist.
	DeleteServingConfig(ctx context.Context, in *DeleteServingConfigRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Updates a ServingConfig.
	UpdateServingConfig(ctx context.Context, in *UpdateServingConfigRequest, opts ...grpc.CallOption) (*ServingConfig, error)
	// Gets a ServingConfig.
	//
	// Returns a NotFound error if the ServingConfig does not exist.
	GetServingConfig(ctx context.Context, in *GetServingConfigRequest, opts ...grpc.CallOption) (*ServingConfig, error)
	// Lists all ServingConfigs linked to this catalog.
	ListServingConfigs(ctx context.Context, in *ListServingConfigsRequest, opts ...grpc.CallOption) (*ListServingConfigsResponse, error)
	// 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.
	AddControl(ctx context.Context, in *AddControlRequest, opts ...grpc.CallOption) (*ServingConfig, error)
	// 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.
	RemoveControl(ctx context.Context, in *RemoveControlRequest, opts ...grpc.CallOption) (*ServingConfig, error)
}

ServingConfigServiceClient is the client API for ServingConfigService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewServingConfigServiceClient

func NewServingConfigServiceClient(cc grpc.ClientConnInterface) ServingConfigServiceClient

ServingConfigServiceServer

type ServingConfigServiceServer interface {
	// Creates a ServingConfig.
	//
	// A maximum of 100 [ServingConfig][google.cloud.retail.v2beta.ServingConfig]s
	// are allowed in a [Catalog][google.cloud.retail.v2beta.Catalog], otherwise
	// a FAILED_PRECONDITION error is returned.
	CreateServingConfig(context.Context, *CreateServingConfigRequest) (*ServingConfig, error)
	// Deletes a ServingConfig.
	//
	// Returns a NotFound error if the ServingConfig does not exist.
	DeleteServingConfig(context.Context, *DeleteServingConfigRequest) (*emptypb.Empty, error)
	// Updates a ServingConfig.
	UpdateServingConfig(context.Context, *UpdateServingConfigRequest) (*ServingConfig, error)
	// Gets a ServingConfig.
	//
	// Returns a NotFound error if the ServingConfig does not exist.
	GetServingConfig(context.Context, *GetServingConfigRequest) (*ServingConfig, error)
	// Lists all ServingConfigs linked to this catalog.
	ListServingConfigs(context.Context, *ListServingConfigsRequest) (*ListServingConfigsResponse, error)
	// 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.
	AddControl(context.Context, *AddControlRequest) (*ServingConfig, error)
	// 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.
	RemoveControl(context.Context, *RemoveControlRequest) (*ServingConfig, error)
}

ServingConfigServiceServer is the server API for ServingConfigService service.

ServingConfig_DiversityType

type ServingConfig_DiversityType int32

What type of diversity - data or rule based.

ServingConfig_DIVERSITY_TYPE_UNSPECIFIED, ServingConfig_RULE_BASED_DIVERSITY, ServingConfig_DATA_DRIVEN_DIVERSITY

const (
	// Default value.
	ServingConfig_DIVERSITY_TYPE_UNSPECIFIED ServingConfig_DiversityType = 0
	// Rule based diversity.
	ServingConfig_RULE_BASED_DIVERSITY ServingConfig_DiversityType = 2
	// Data driven diversity.
	ServingConfig_DATA_DRIVEN_DIVERSITY ServingConfig_DiversityType = 3
)

func (ServingConfig_DiversityType) Descriptor

func (ServingConfig_DiversityType) Descriptor() protoreflect.EnumDescriptor

func (ServingConfig_DiversityType) Enum

func (x ServingConfig_DiversityType) Enum() *ServingConfig_DiversityType

func (ServingConfig_DiversityType) EnumDescriptor

func (ServingConfig_DiversityType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ServingConfig_DiversityType.Descriptor instead.

func (ServingConfig_DiversityType) Number

func (x ServingConfig_DiversityType) Number() protoreflect.EnumNumber

func (ServingConfig_DiversityType) String

func (x ServingConfig_DiversityType) String() string

func (ServingConfig_DiversityType) Type

func (ServingConfig_DiversityType) Type() protoreflect.EnumType

SetDefaultBranchRequest

type SetDefaultBranchRequest struct {

	// Full resource name of the catalog, such as
	// `projects/*/locations/global/catalogs/default_catalog`.
	Catalog string `protobuf:"bytes,1,opt,name=catalog,proto3" json:"catalog,omitempty"`
	// The final component of the resource name of a branch.
	//
	// This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
	// error is returned.
	//
	// If there are no sufficient active products in the targeted branch and
	// [force][google.cloud.retail.v2beta.SetDefaultBranchRequest.force] is not
	// set, a FAILED_PRECONDITION error is returned.
	BranchId string `protobuf:"bytes,2,opt,name=branch_id,json=branchId,proto3" json:"branch_id,omitempty"`
	// Some note on this request, this can be retrieved by
	// [CatalogService.GetDefaultBranch][google.cloud.retail.v2beta.CatalogService.GetDefaultBranch]
	// before next valid default branch set occurs.
	//
	// This field must be a UTF-8 encoded string with a length limit of 1,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	Note string `protobuf:"bytes,3,opt,name=note,proto3" json:"note,omitempty"`
	// If set to true, it permits switching to a branch with
	// [branch_id][google.cloud.retail.v2beta.SetDefaultBranchRequest.branch_id]
	// even if it has no sufficient active products.
	Force bool `protobuf:"varint,4,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message to set a specified branch as new default_branch.

func (*SetDefaultBranchRequest) Descriptor

func (*SetDefaultBranchRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetDefaultBranchRequest.ProtoReflect.Descriptor instead.

func (*SetDefaultBranchRequest) GetBranchId

func (x *SetDefaultBranchRequest) GetBranchId() string

func (*SetDefaultBranchRequest) GetCatalog

func (x *SetDefaultBranchRequest) GetCatalog() string

func (*SetDefaultBranchRequest) GetForce

func (x *SetDefaultBranchRequest) GetForce() bool

func (*SetDefaultBranchRequest) GetNote

func (x *SetDefaultBranchRequest) GetNote() string

func (*SetDefaultBranchRequest) ProtoMessage

func (*SetDefaultBranchRequest) ProtoMessage()

func (*SetDefaultBranchRequest) ProtoReflect

func (x *SetDefaultBranchRequest) ProtoReflect() protoreflect.Message

func (*SetDefaultBranchRequest) Reset

func (x *SetDefaultBranchRequest) Reset()

func (*SetDefaultBranchRequest) String

func (x *SetDefaultBranchRequest) String() string

SetInventoryMetadata

type SetInventoryMetadata struct {
	// contains filtered or unexported fields
}

Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the [ProductService.SetInventory][google.cloud.retail.v2beta.ProductService.SetInventory] method.

func (*SetInventoryMetadata) Descriptor

func (*SetInventoryMetadata) Descriptor() ([]byte, []int)

Deprecated: Use SetInventoryMetadata.ProtoReflect.Descriptor instead.

func (*SetInventoryMetadata) ProtoMessage

func (*SetInventoryMetadata) ProtoMessage()

func (*SetInventoryMetadata) ProtoReflect

func (x *SetInventoryMetadata) ProtoReflect() protoreflect.Message

func (*SetInventoryMetadata) Reset

func (x *SetInventoryMetadata) Reset()

func (*SetInventoryMetadata) String

func (x *SetInventoryMetadata) String() string

SetInventoryRequest

type SetInventoryRequest struct {

	// Required. The inventory information to update. The allowable fields to
	// update are:
	//
	// * [Product.price_info][google.cloud.retail.v2beta.Product.price_info]
	// * [Product.availability][google.cloud.retail.v2beta.Product.availability]
	// * [Product.available_quantity][google.cloud.retail.v2beta.Product.available_quantity]
	// * [Product.fulfillment_info][google.cloud.retail.v2beta.Product.fulfillment_info]
	// The updated inventory fields must be specified in
	// [SetInventoryRequest.set_mask][google.cloud.retail.v2beta.SetInventoryRequest.set_mask].
	//
	// If
	// [SetInventoryRequest.inventory.name][google.cloud.retail.v2beta.Product.name]
	// is empty or invalid, an INVALID_ARGUMENT error is returned.
	//
	// If the caller does not have permission to update the
	// [Product][google.cloud.retail.v2beta.Product] named in
	// [Product.name][google.cloud.retail.v2beta.Product.name], regardless of
	// whether or not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Product][google.cloud.retail.v2beta.Product] to update does not
	// have existing inventory information, the provided inventory information
	// will be inserted.
	//
	// If the [Product][google.cloud.retail.v2beta.Product] to update has existing
	// inventory information, the provided inventory information will be merged
	// while respecting the last update time for each inventory field, using the
	// provided or default value for
	// [SetInventoryRequest.set_time][google.cloud.retail.v2beta.SetInventoryRequest.set_time].
	//
	// The caller can replace place IDs for a subset of fulfillment types in the
	// following ways:
	//
	// * Adds "fulfillment_info" in
	// [SetInventoryRequest.set_mask][google.cloud.retail.v2beta.SetInventoryRequest.set_mask]
	// * Specifies only the desired fulfillment types and corresponding place IDs
	// to update in
	// [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2beta.Product.fulfillment_info]
	//
	// The caller can clear all place IDs from a subset of fulfillment types in
	// the following ways:
	//
	// * Adds "fulfillment_info" in
	// [SetInventoryRequest.set_mask][google.cloud.retail.v2beta.SetInventoryRequest.set_mask]
	// * Specifies only the desired fulfillment types to clear in
	// [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2beta.Product.fulfillment_info]
	// * Checks that only the desired fulfillment info types have empty
	// [SetInventoryRequest.inventory.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids]
	//
	// The last update time is recorded for the following inventory fields:
	// * [Product.price_info][google.cloud.retail.v2beta.Product.price_info]
	// * [Product.availability][google.cloud.retail.v2beta.Product.availability]
	// * [Product.available_quantity][google.cloud.retail.v2beta.Product.available_quantity]
	// * [Product.fulfillment_info][google.cloud.retail.v2beta.Product.fulfillment_info]
	//
	// If a full overwrite of inventory information while ignoring timestamps is
	// needed,
	// [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct]
	// should be invoked instead.
	Inventory *Product `protobuf:"bytes,1,opt,name=inventory,proto3" json:"inventory,omitempty"`
	// Indicates which inventory fields in the provided
	// [Product][google.cloud.retail.v2beta.Product] to update.
	//
	// At least one field must be provided.
	//
	// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
	// is returned and the entire update will be ignored.
	SetMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=set_mask,json=setMask,proto3" json:"set_mask,omitempty"`
	// The time when the request is issued, used to prevent
	// out-of-order updates on inventory fields with the last update time
	// recorded. If not provided, the internal system time will be used.
	SetTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=set_time,json=setTime,proto3" json:"set_time,omitempty"`
	// If set to true, and the [Product][google.cloud.retail.v2beta.Product] with
	// name [Product.name][google.cloud.retail.v2beta.Product.name] is not found,
	// the inventory update will still be processed and retained for at most 1 day
	// until the [Product][google.cloud.retail.v2beta.Product] is created. If set
	// to false, a NOT_FOUND error is returned if the
	// [Product][google.cloud.retail.v2beta.Product] is not found.
	AllowMissing bool `protobuf:"varint,4,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProductService.SetInventory][google.cloud.retail.v2beta.ProductService.SetInventory] method.

func (*SetInventoryRequest) Descriptor

func (*SetInventoryRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetInventoryRequest.ProtoReflect.Descriptor instead.

func (*SetInventoryRequest) GetAllowMissing

func (x *SetInventoryRequest) GetAllowMissing() bool

func (*SetInventoryRequest) GetInventory

func (x *SetInventoryRequest) GetInventory() *Product

func (*SetInventoryRequest) GetSetMask

func (x *SetInventoryRequest) GetSetMask() *fieldmaskpb.FieldMask

func (*SetInventoryRequest) GetSetTime

func (x *SetInventoryRequest) GetSetTime() *timestamppb.Timestamp

func (*SetInventoryRequest) ProtoMessage

func (*SetInventoryRequest) ProtoMessage()

func (*SetInventoryRequest) ProtoReflect

func (x *SetInventoryRequest) ProtoReflect() protoreflect.Message

func (*SetInventoryRequest) Reset

func (x *SetInventoryRequest) Reset()

func (*SetInventoryRequest) String

func (x *SetInventoryRequest) String() string

SetInventoryResponse

type SetInventoryResponse struct {
	// contains filtered or unexported fields
}

Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the [ProductService.SetInventory][google.cloud.retail.v2beta.ProductService.SetInventory] method.

func (*SetInventoryResponse) Descriptor

func (*SetInventoryResponse) Descriptor() ([]byte, []int)

Deprecated: Use SetInventoryResponse.ProtoReflect.Descriptor instead.

func (*SetInventoryResponse) ProtoMessage

func (*SetInventoryResponse) ProtoMessage()

func (*SetInventoryResponse) ProtoReflect

func (x *SetInventoryResponse) ProtoReflect() protoreflect.Message

func (*SetInventoryResponse) Reset

func (x *SetInventoryResponse) Reset()

func (*SetInventoryResponse) String

func (x *SetInventoryResponse) String() string

SolutionType

type SolutionType int32

The type of solution.

SolutionType_SOLUTION_TYPE_UNSPECIFIED, SolutionType_SOLUTION_TYPE_RECOMMENDATION, SolutionType_SOLUTION_TYPE_SEARCH

const (
	// Default value.
	SolutionType_SOLUTION_TYPE_UNSPECIFIED SolutionType = 0
	// Used for Recommendations AI.
	SolutionType_SOLUTION_TYPE_RECOMMENDATION SolutionType = 1
	// Used for Retail Search.
	SolutionType_SOLUTION_TYPE_SEARCH SolutionType = 2
)

func (SolutionType) Descriptor

func (SolutionType) Descriptor() protoreflect.EnumDescriptor

func (SolutionType) Enum

func (x SolutionType) Enum() *SolutionType

func (SolutionType) EnumDescriptor

func (SolutionType) EnumDescriptor() ([]byte, []int)

Deprecated: Use SolutionType.Descriptor instead.

func (SolutionType) Number

func (x SolutionType) Number() protoreflect.EnumNumber

func (SolutionType) String

func (x SolutionType) String() string

func (SolutionType) Type

func (SolutionType) Type() protoreflect.EnumType

TuneModelMetadata

type TuneModelMetadata struct {

	// The resource name of the model that this tune applies to.
	// Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// contains filtered or unexported fields
}

Metadata associated with a tune operation.

func (*TuneModelMetadata) Descriptor

func (*TuneModelMetadata) Descriptor() ([]byte, []int)

Deprecated: Use TuneModelMetadata.ProtoReflect.Descriptor instead.

func (*TuneModelMetadata) GetModel

func (x *TuneModelMetadata) GetModel() string

func (*TuneModelMetadata) ProtoMessage

func (*TuneModelMetadata) ProtoMessage()

func (*TuneModelMetadata) ProtoReflect

func (x *TuneModelMetadata) ProtoReflect() protoreflect.Message

func (*TuneModelMetadata) Reset

func (x *TuneModelMetadata) Reset()

func (*TuneModelMetadata) String

func (x *TuneModelMetadata) String() string

TuneModelRequest

type TuneModelRequest struct {

	// Required. The resource name of the model to tune.
	// Format:
	// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

func (*TuneModelRequest) Descriptor

func (*TuneModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use TuneModelRequest.ProtoReflect.Descriptor instead.

func (*TuneModelRequest) GetName

func (x *TuneModelRequest) GetName() string

func (*TuneModelRequest) ProtoMessage

func (*TuneModelRequest) ProtoMessage()

func (*TuneModelRequest) ProtoReflect

func (x *TuneModelRequest) ProtoReflect() protoreflect.Message

func (*TuneModelRequest) Reset

func (x *TuneModelRequest) Reset()

func (*TuneModelRequest) String

func (x *TuneModelRequest) String() string

TuneModelResponse

type TuneModelResponse struct {
	// contains filtered or unexported fields
}

Response associated with a tune operation.

func (*TuneModelResponse) Descriptor

func (*TuneModelResponse) Descriptor() ([]byte, []int)

Deprecated: Use TuneModelResponse.ProtoReflect.Descriptor instead.

func (*TuneModelResponse) ProtoMessage

func (*TuneModelResponse) ProtoMessage()

func (*TuneModelResponse) ProtoReflect

func (x *TuneModelResponse) ProtoReflect() protoreflect.Message

func (*TuneModelResponse) Reset

func (x *TuneModelResponse) Reset()

func (*TuneModelResponse) String

func (x *TuneModelResponse) String() string

UnimplementedAnalyticsServiceServer

type UnimplementedAnalyticsServiceServer struct {
}

UnimplementedAnalyticsServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedAnalyticsServiceServer) ExportAnalyticsMetrics

func (*UnimplementedAnalyticsServiceServer) ExportAnalyticsMetrics(context.Context, *ExportAnalyticsMetricsRequest) (*longrunningpb.Operation, error)

UnimplementedCatalogServiceServer

type UnimplementedCatalogServiceServer struct {
}

UnimplementedCatalogServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCatalogServiceServer) AddCatalogAttribute

func (*UnimplementedCatalogServiceServer) AddCatalogAttribute(context.Context, *AddCatalogAttributeRequest) (*AttributesConfig, error)

func (*UnimplementedCatalogServiceServer) BatchRemoveCatalogAttributes

func (*UnimplementedCatalogServiceServer) BatchRemoveCatalogAttributes(context.Context, *BatchRemoveCatalogAttributesRequest) (*BatchRemoveCatalogAttributesResponse, error)

func (*UnimplementedCatalogServiceServer) GetAttributesConfig

func (*UnimplementedCatalogServiceServer) GetAttributesConfig(context.Context, *GetAttributesConfigRequest) (*AttributesConfig, error)

func (*UnimplementedCatalogServiceServer) GetCompletionConfig

func (*UnimplementedCatalogServiceServer) GetCompletionConfig(context.Context, *GetCompletionConfigRequest) (*CompletionConfig, error)

func (*UnimplementedCatalogServiceServer) GetDefaultBranch

func (*UnimplementedCatalogServiceServer) GetDefaultBranch(context.Context, *GetDefaultBranchRequest) (*GetDefaultBranchResponse, error)

func (*UnimplementedCatalogServiceServer) ListCatalogs

func (*UnimplementedCatalogServiceServer) ListCatalogs(context.Context, *ListCatalogsRequest) (*ListCatalogsResponse, error)

func (*UnimplementedCatalogServiceServer) RemoveCatalogAttribute

func (*UnimplementedCatalogServiceServer) RemoveCatalogAttribute(context.Context, *RemoveCatalogAttributeRequest) (*AttributesConfig, error)

func (*UnimplementedCatalogServiceServer) ReplaceCatalogAttribute

func (*UnimplementedCatalogServiceServer) ReplaceCatalogAttribute(context.Context, *ReplaceCatalogAttributeRequest) (*AttributesConfig, error)

func (*UnimplementedCatalogServiceServer) SetDefaultBranch

func (*UnimplementedCatalogServiceServer) SetDefaultBranch(context.Context, *SetDefaultBranchRequest) (*emptypb.Empty, error)

func (*UnimplementedCatalogServiceServer) UpdateAttributesConfig

func (*UnimplementedCatalogServiceServer) UpdateAttributesConfig(context.Context, *UpdateAttributesConfigRequest) (*AttributesConfig, error)

func (*UnimplementedCatalogServiceServer) UpdateCatalog

func (*UnimplementedCatalogServiceServer) UpdateCatalog(context.Context, *UpdateCatalogRequest) (*Catalog, error)

func (*UnimplementedCatalogServiceServer) UpdateCompletionConfig

func (*UnimplementedCatalogServiceServer) UpdateCompletionConfig(context.Context, *UpdateCompletionConfigRequest) (*CompletionConfig, error)

UnimplementedCompletionServiceServer

type UnimplementedCompletionServiceServer struct {
}

UnimplementedCompletionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCompletionServiceServer) CompleteQuery

func (*UnimplementedCompletionServiceServer) CompleteQuery(context.Context, *CompleteQueryRequest) (*CompleteQueryResponse, error)

func (*UnimplementedCompletionServiceServer) ImportCompletionData

func (*UnimplementedCompletionServiceServer) ImportCompletionData(context.Context, *ImportCompletionDataRequest) (*longrunningpb.Operation, error)

UnimplementedControlServiceServer

type UnimplementedControlServiceServer struct {
}

UnimplementedControlServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedControlServiceServer) CreateControl

func (*UnimplementedControlServiceServer) CreateControl(context.Context, *CreateControlRequest) (*Control, error)

func (*UnimplementedControlServiceServer) DeleteControl

func (*UnimplementedControlServiceServer) DeleteControl(context.Context, *DeleteControlRequest) (*emptypb.Empty, error)

func (*UnimplementedControlServiceServer) GetControl

func (*UnimplementedControlServiceServer) GetControl(context.Context, *GetControlRequest) (*Control, error)

func (*UnimplementedControlServiceServer) ListControls

func (*UnimplementedControlServiceServer) ListControls(context.Context, *ListControlsRequest) (*ListControlsResponse, error)

func (*UnimplementedControlServiceServer) UpdateControl

func (*UnimplementedControlServiceServer) UpdateControl(context.Context, *UpdateControlRequest) (*Control, error)

UnimplementedModelServiceServer

type UnimplementedModelServiceServer struct {
}

UnimplementedModelServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedModelServiceServer) CreateModel

func (*UnimplementedModelServiceServer) CreateModel(context.Context, *CreateModelRequest) (*longrunningpb.Operation, error)

func (*UnimplementedModelServiceServer) DeleteModel

func (*UnimplementedModelServiceServer) DeleteModel(context.Context, *DeleteModelRequest) (*emptypb.Empty, error)

func (*UnimplementedModelServiceServer) GetModel

func (*UnimplementedModelServiceServer) GetModel(context.Context, *GetModelRequest) (*Model, error)

func (*UnimplementedModelServiceServer) ListModels

func (*UnimplementedModelServiceServer) ListModels(context.Context, *ListModelsRequest) (*ListModelsResponse, error)

func (*UnimplementedModelServiceServer) PauseModel

func (*UnimplementedModelServiceServer) PauseModel(context.Context, *PauseModelRequest) (*Model, error)

func (*UnimplementedModelServiceServer) ResumeModel

func (*UnimplementedModelServiceServer) ResumeModel(context.Context, *ResumeModelRequest) (*Model, error)

func (*UnimplementedModelServiceServer) TuneModel

func (*UnimplementedModelServiceServer) TuneModel(context.Context, *TuneModelRequest) (*longrunningpb.Operation, error)

func (*UnimplementedModelServiceServer) UpdateModel

func (*UnimplementedModelServiceServer) UpdateModel(context.Context, *UpdateModelRequest) (*Model, error)

UnimplementedPredictionServiceServer

type UnimplementedPredictionServiceServer struct {
}

UnimplementedPredictionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedPredictionServiceServer) Predict

func (*UnimplementedPredictionServiceServer) Predict(context.Context, *PredictRequest) (*PredictResponse, error)

UnimplementedProductServiceServer

type UnimplementedProductServiceServer struct {
}

UnimplementedProductServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedProductServiceServer) AddFulfillmentPlaces

func (*UnimplementedProductServiceServer) AddFulfillmentPlaces(context.Context, *AddFulfillmentPlacesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedProductServiceServer) AddLocalInventories

func (*UnimplementedProductServiceServer) AddLocalInventories(context.Context, *AddLocalInventoriesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedProductServiceServer) CreateProduct

func (*UnimplementedProductServiceServer) CreateProduct(context.Context, *CreateProductRequest) (*Product, error)

func (*UnimplementedProductServiceServer) DeleteProduct

func (*UnimplementedProductServiceServer) DeleteProduct(context.Context, *DeleteProductRequest) (*emptypb.Empty, error)

func (*UnimplementedProductServiceServer) GetProduct

func (*UnimplementedProductServiceServer) GetProduct(context.Context, *GetProductRequest) (*Product, error)

func (*UnimplementedProductServiceServer) ImportProducts

func (*UnimplementedProductServiceServer) ImportProducts(context.Context, *ImportProductsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedProductServiceServer) ListProducts

func (*UnimplementedProductServiceServer) ListProducts(context.Context, *ListProductsRequest) (*ListProductsResponse, error)

func (*UnimplementedProductServiceServer) RemoveFulfillmentPlaces

func (*UnimplementedProductServiceServer) RemoveFulfillmentPlaces(context.Context, *RemoveFulfillmentPlacesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedProductServiceServer) RemoveLocalInventories

func (*UnimplementedProductServiceServer) RemoveLocalInventories(context.Context, *RemoveLocalInventoriesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedProductServiceServer) SetInventory

func (*UnimplementedProductServiceServer) SetInventory(context.Context, *SetInventoryRequest) (*longrunningpb.Operation, error)

func (*UnimplementedProductServiceServer) UpdateProduct

func (*UnimplementedProductServiceServer) UpdateProduct(context.Context, *UpdateProductRequest) (*Product, error)

UnimplementedSearchServiceServer

type UnimplementedSearchServiceServer struct {
}

UnimplementedSearchServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedSearchServiceServer) Search

func (*UnimplementedSearchServiceServer) Search(context.Context, *SearchRequest) (*SearchResponse, error)

UnimplementedServingConfigServiceServer

type UnimplementedServingConfigServiceServer struct {
}

UnimplementedServingConfigServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedServingConfigServiceServer) AddControl

func (*UnimplementedServingConfigServiceServer) AddControl(context.Context, *AddControlRequest) (*ServingConfig, error)

func (*UnimplementedServingConfigServiceServer) CreateServingConfig

func (*UnimplementedServingConfigServiceServer) CreateServingConfig(context.Context, *CreateServingConfigRequest) (*ServingConfig, error)

func (*UnimplementedServingConfigServiceServer) DeleteServingConfig

func (*UnimplementedServingConfigServiceServer) DeleteServingConfig(context.Context, *DeleteServingConfigRequest) (*emptypb.Empty, error)

func (*UnimplementedServingConfigServiceServer) GetServingConfig

func (*UnimplementedServingConfigServiceServer) GetServingConfig(context.Context, *GetServingConfigRequest) (*ServingConfig, error)

func (*UnimplementedServingConfigServiceServer) ListServingConfigs

func (*UnimplementedServingConfigServiceServer) ListServingConfigs(context.Context, *ListServingConfigsRequest) (*ListServingConfigsResponse, error)

func (*UnimplementedServingConfigServiceServer) RemoveControl

func (*UnimplementedServingConfigServiceServer) RemoveControl(context.Context, *RemoveControlRequest) (*ServingConfig, error)

func (*UnimplementedServingConfigServiceServer) UpdateServingConfig

func (*UnimplementedServingConfigServiceServer) UpdateServingConfig(context.Context, *UpdateServingConfigRequest) (*ServingConfig, error)

UnimplementedUserEventServiceServer

type UnimplementedUserEventServiceServer struct {
}

UnimplementedUserEventServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedUserEventServiceServer) CollectUserEvent

func (*UnimplementedUserEventServiceServer) CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)

func (*UnimplementedUserEventServiceServer) ImportUserEvents

func (*UnimplementedUserEventServiceServer) ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedUserEventServiceServer) PurgeUserEvents

func (*UnimplementedUserEventServiceServer) PurgeUserEvents(context.Context, *PurgeUserEventsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedUserEventServiceServer) RejoinUserEvents

func (*UnimplementedUserEventServiceServer) RejoinUserEvents(context.Context, *RejoinUserEventsRequest) (*longrunningpb.Operation, error)

func (*UnimplementedUserEventServiceServer) WriteUserEvent

func (*UnimplementedUserEventServiceServer) WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)

UpdateAttributesConfigRequest

type UpdateAttributesConfigRequest struct {

	// Required. The
	// [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig] to update.
	AttributesConfig *AttributesConfig `protobuf:"bytes,1,opt,name=attributes_config,json=attributesConfig,proto3" json:"attributes_config,omitempty"`
	// Indicates which fields in the provided
	// [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig] to update.
	// The following is the only supported field:
	//
	// * [AttributesConfig.catalog_attributes][google.cloud.retail.v2beta.AttributesConfig.catalog_attributes]
	//
	// If not set, all supported fields are updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.UpdateAttributesConfig][google.cloud.retail.v2beta.CatalogService.UpdateAttributesConfig] method.

func (*UpdateAttributesConfigRequest) Descriptor

func (*UpdateAttributesConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateAttributesConfigRequest.ProtoReflect.Descriptor instead.

func (*UpdateAttributesConfigRequest) GetAttributesConfig

func (x *UpdateAttributesConfigRequest) GetAttributesConfig() *AttributesConfig

func (*UpdateAttributesConfigRequest) GetUpdateMask

func (x *UpdateAttributesConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateAttributesConfigRequest) ProtoMessage

func (*UpdateAttributesConfigRequest) ProtoMessage()

func (*UpdateAttributesConfigRequest) ProtoReflect

func (x *UpdateAttributesConfigRequest) ProtoReflect() protoreflect.Message

func (*UpdateAttributesConfigRequest) Reset

func (x *UpdateAttributesConfigRequest) Reset()

func (*UpdateAttributesConfigRequest) String

func (x *UpdateAttributesConfigRequest) String() string

UpdateCatalogRequest

type UpdateCatalogRequest struct {

	// Required. The [Catalog][google.cloud.retail.v2beta.Catalog] to update.
	//
	// If the caller does not have permission to update the
	// [Catalog][google.cloud.retail.v2beta.Catalog], regardless of whether or not
	// it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Catalog][google.cloud.retail.v2beta.Catalog] to update does not
	// exist, a NOT_FOUND error is returned.
	Catalog *Catalog `protobuf:"bytes,1,opt,name=catalog,proto3" json:"catalog,omitempty"`
	// Indicates which fields in the provided
	// [Catalog][google.cloud.retail.v2beta.Catalog] to update.
	//
	// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
	// is returned.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.UpdateCatalog][google.cloud.retail.v2beta.CatalogService.UpdateCatalog] method.

func (*UpdateCatalogRequest) Descriptor

func (*UpdateCatalogRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateCatalogRequest.ProtoReflect.Descriptor instead.

func (*UpdateCatalogRequest) GetCatalog

func (x *UpdateCatalogRequest) GetCatalog() *Catalog

func (*UpdateCatalogRequest) GetUpdateMask

func (x *UpdateCatalogRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateCatalogRequest) ProtoMessage

func (*UpdateCatalogRequest) ProtoMessage()

func (*UpdateCatalogRequest) ProtoReflect

func (x *UpdateCatalogRequest) ProtoReflect() protoreflect.Message

func (*UpdateCatalogRequest) Reset

func (x *UpdateCatalogRequest) Reset()

func (*UpdateCatalogRequest) String

func (x *UpdateCatalogRequest) String() string

UpdateCompletionConfigRequest

type UpdateCompletionConfigRequest struct {

	// Required. The
	// [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig] to update.
	//
	// If the caller does not have permission to update the
	// [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig], then a
	// PERMISSION_DENIED error is returned.
	//
	// If the [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig] to
	// update does not exist, a NOT_FOUND error is returned.
	CompletionConfig *CompletionConfig `protobuf:"bytes,1,opt,name=completion_config,json=completionConfig,proto3" json:"completion_config,omitempty"`
	// Indicates which fields in the provided
	// [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig] to update.
	// The following are the only supported fields:
	//
	// * [CompletionConfig.matching_order][google.cloud.retail.v2beta.CompletionConfig.matching_order]
	// * [CompletionConfig.max_suggestions][google.cloud.retail.v2beta.CompletionConfig.max_suggestions]
	// * [CompletionConfig.min_prefix_length][google.cloud.retail.v2beta.CompletionConfig.min_prefix_length]
	// * [CompletionConfig.auto_learning][google.cloud.retail.v2beta.CompletionConfig.auto_learning]
	//
	// If not set, all supported fields are updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.UpdateCompletionConfig][google.cloud.retail.v2beta.CatalogService.UpdateCompletionConfig] method.

func (*UpdateCompletionConfigRequest) Descriptor

func (*UpdateCompletionConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateCompletionConfigRequest.ProtoReflect.Descriptor instead.

func (*UpdateCompletionConfigRequest) GetCompletionConfig

func (x *UpdateCompletionConfigRequest) GetCompletionConfig() *CompletionConfig

func (*UpdateCompletionConfigRequest) GetUpdateMask

func (x *UpdateCompletionConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateCompletionConfigRequest) ProtoMessage

func (*UpdateCompletionConfigRequest) ProtoMessage()

func (*UpdateCompletionConfigRequest) ProtoReflect

func (x *UpdateCompletionConfigRequest) ProtoReflect() protoreflect.Message

func (*UpdateCompletionConfigRequest) Reset

func (x *UpdateCompletionConfigRequest) Reset()

func (*UpdateCompletionConfigRequest) String

func (x *UpdateCompletionConfigRequest) String() string

UpdateControlRequest

type UpdateControlRequest struct {

	// Required. The Control to update.
	Control *Control `protobuf:"bytes,1,opt,name=control,proto3" json:"control,omitempty"`
	// Indicates which fields in the provided
	// [Control][google.cloud.retail.v2beta.Control] to update. The following are
	// NOT supported:
	//
	// * [Control.name][google.cloud.retail.v2beta.Control.name]
	//
	// If not set or empty, all supported fields are updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for UpdateControl method.

func (*UpdateControlRequest) Descriptor

func (*UpdateControlRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateControlRequest.ProtoReflect.Descriptor instead.

func (*UpdateControlRequest) GetControl

func (x *UpdateControlRequest) GetControl() *Control

func (*UpdateControlRequest) GetUpdateMask

func (x *UpdateControlRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateControlRequest) ProtoMessage

func (*UpdateControlRequest) ProtoMessage()

func (*UpdateControlRequest) ProtoReflect

func (x *UpdateControlRequest) ProtoReflect() protoreflect.Message

func (*UpdateControlRequest) Reset

func (x *UpdateControlRequest) Reset()

func (*UpdateControlRequest) String

func (x *UpdateControlRequest) String() string

UpdateModelRequest

type UpdateModelRequest struct {

	// Required. The body of the updated
	// [Model][google.cloud.retail.v2beta.Model].
	Model *Model `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Optional. Indicates which fields in the provided 'model' to
	// update. If not set, by default updates all fields.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for updating an existing model.

func (*UpdateModelRequest) Descriptor

func (*UpdateModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateModelRequest.ProtoReflect.Descriptor instead.

func (*UpdateModelRequest) GetModel

func (x *UpdateModelRequest) GetModel() *Model

func (*UpdateModelRequest) GetUpdateMask

func (x *UpdateModelRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateModelRequest) ProtoMessage

func (*UpdateModelRequest) ProtoMessage()

func (*UpdateModelRequest) ProtoReflect

func (x *UpdateModelRequest) ProtoReflect() protoreflect.Message

func (*UpdateModelRequest) Reset

func (x *UpdateModelRequest) Reset()

func (*UpdateModelRequest) String

func (x *UpdateModelRequest) String() string

UpdateProductRequest

type UpdateProductRequest struct {

	// Required. The product to update/create.
	//
	// If the caller does not have permission to update the
	// [Product][google.cloud.retail.v2beta.Product], regardless of whether or not
	// it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Product][google.cloud.retail.v2beta.Product] to update does not
	// exist and
	// [allow_missing][google.cloud.retail.v2beta.UpdateProductRequest.allow_missing]
	// is not set, a NOT_FOUND error is returned.
	Product *Product `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
	// Indicates which fields in the provided
	// [Product][google.cloud.retail.v2beta.Product] to update. The immutable and
	// output only fields are NOT supported. If not set, all supported fields (the
	// fields that are neither immutable nor output only) are updated.
	//
	// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
	// is returned.
	//
	// The attribute key can be updated by setting the mask path as
	// "attributes.${key_name}". If a key name is present in the mask but not in
	// the patching product from the request, this key will be deleted after the
	// update.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// If set to true, and the [Product][google.cloud.retail.v2beta.Product] is
	// not found, a new [Product][google.cloud.retail.v2beta.Product] will be
	// created. In this situation, `update_mask` is ignored.
	AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Request message for [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct] method.

func (*UpdateProductRequest) Descriptor

func (*UpdateProductRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateProductRequest.ProtoReflect.Descriptor instead.

func (*UpdateProductRequest) GetAllowMissing

func (x *UpdateProductRequest) GetAllowMissing() bool

func (*UpdateProductRequest) GetProduct

func (x *UpdateProductRequest) GetProduct() *Product

func (*UpdateProductRequest) GetUpdateMask

func (x *UpdateProductRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateProductRequest) ProtoMessage

func (*UpdateProductRequest) ProtoMessage()

func (*UpdateProductRequest) ProtoReflect

func (x *UpdateProductRequest) ProtoReflect() protoreflect.Message

func (*UpdateProductRequest) Reset

func (x *UpdateProductRequest) Reset()

func (*UpdateProductRequest) String

func (x *UpdateProductRequest) String() string

UpdateServingConfigRequest

type UpdateServingConfigRequest struct {

	// Required. The ServingConfig to update.
	ServingConfig *ServingConfig `protobuf:"bytes,1,opt,name=serving_config,json=servingConfig,proto3" json:"serving_config,omitempty"`
	// Indicates which fields in the provided
	// [ServingConfig][google.cloud.retail.v2beta.ServingConfig] to update. The
	// following are NOT supported:
	//
	// * [ServingConfig.name][google.cloud.retail.v2beta.ServingConfig.name]
	//
	// If not set, all supported fields are updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for UpdateServingConfig method.

func (*UpdateServingConfigRequest) Descriptor

func (*UpdateServingConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateServingConfigRequest.ProtoReflect.Descriptor instead.

func (*UpdateServingConfigRequest) GetServingConfig

func (x *UpdateServingConfigRequest) GetServingConfig() *ServingConfig

func (*UpdateServingConfigRequest) GetUpdateMask

func (x *UpdateServingConfigRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateServingConfigRequest) ProtoMessage

func (*UpdateServingConfigRequest) ProtoMessage()

func (*UpdateServingConfigRequest) ProtoReflect

func (x *UpdateServingConfigRequest) ProtoReflect() protoreflect.Message

func (*UpdateServingConfigRequest) Reset

func (x *UpdateServingConfigRequest) Reset()

func (*UpdateServingConfigRequest) String

func (x *UpdateServingConfigRequest) String() string

UserEvent

type UserEvent struct {
	EventType string `protobuf:"bytes,1,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`

	VisitorId string `protobuf:"bytes,2,opt,name=visitor_id,json=visitorId,proto3" json:"visitor_id,omitempty"`

	SessionId string `protobuf:"bytes,21,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`

	EventTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`

	ExperimentIds []string `protobuf:"bytes,4,rep,name=experiment_ids,json=experimentIds,proto3" json:"experiment_ids,omitempty"`

	AttributionToken string `protobuf:"bytes,5,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`

	ProductDetails []*ProductDetail `protobuf:"bytes,6,rep,name=product_details,json=productDetails,proto3" json:"product_details,omitempty"`

	CompletionDetail *CompletionDetail `protobuf:"bytes,22,opt,name=completion_detail,json=completionDetail,proto3" json:"completion_detail,omitempty"`

	Attributes map[string]*CustomAttribute "" /* 161 byte string literal not displayed */

	CartId string `protobuf:"bytes,8,opt,name=cart_id,json=cartId,proto3" json:"cart_id,omitempty"`

	PurchaseTransaction *PurchaseTransaction `protobuf:"bytes,9,opt,name=purchase_transaction,json=purchaseTransaction,proto3" json:"purchase_transaction,omitempty"`

	SearchQuery string `protobuf:"bytes,10,opt,name=search_query,json=searchQuery,proto3" json:"search_query,omitempty"`

	Filter string `protobuf:"bytes,16,opt,name=filter,proto3" json:"filter,omitempty"`

	OrderBy string `protobuf:"bytes,17,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`

	Offset int32 `protobuf:"varint,18,opt,name=offset,proto3" json:"offset,omitempty"`

	PageCategories []string `protobuf:"bytes,11,rep,name=page_categories,json=pageCategories,proto3" json:"page_categories,omitempty"`

	UserInfo *UserInfo `protobuf:"bytes,12,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`

	Uri string `protobuf:"bytes,13,opt,name=uri,proto3" json:"uri,omitempty"`

	ReferrerUri string `protobuf:"bytes,14,opt,name=referrer_uri,json=referrerUri,proto3" json:"referrer_uri,omitempty"`

	PageViewId string `protobuf:"bytes,15,opt,name=page_view_id,json=pageViewId,proto3" json:"page_view_id,omitempty"`

	Entity string `protobuf:"bytes,23,opt,name=entity,proto3" json:"entity,omitempty"`

}

UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.

func (*UserEvent) Descriptor

func (*UserEvent) Descriptor() ([]byte, []int)

Deprecated: Use UserEvent.ProtoReflect.Descriptor instead.

func (*UserEvent) GetAttributes

func (x *UserEvent) GetAttributes() map[string]*CustomAttribute

func (*UserEvent) GetAttributionToken

func (x *UserEvent) GetAttributionToken() string

func (*UserEvent) GetCartId

func (x *UserEvent) GetCartId() string

func (*UserEvent) GetCompletionDetail

func (x *UserEvent) GetCompletionDetail() *CompletionDetail

func (*UserEvent) GetEntity

func (x *UserEvent) GetEntity() string

func (*UserEvent) GetEventTime

func (x *UserEvent) GetEventTime() *timestamppb.Timestamp

func (*UserEvent) GetEventType

func (x *UserEvent) GetEventType() string

func (*UserEvent) GetExperimentIds

func (x *UserEvent) GetExperimentIds() []string

func (*UserEvent) GetFilter

func (x *UserEvent) GetFilter() string

func (*UserEvent) GetOffset

func (x *UserEvent) GetOffset() int32

func (*UserEvent) GetOrderBy

func (x *UserEvent) GetOrderBy() string

func (*UserEvent) GetPageCategories

func (x *UserEvent) GetPageCategories() []string

func (*UserEvent) GetPageViewId

func (x *UserEvent) GetPageViewId() string

func (*UserEvent) GetProductDetails

func (x *UserEvent) GetProductDetails() []*ProductDetail

func (*UserEvent) GetPurchaseTransaction

func (x *UserEvent) GetPurchaseTransaction() *PurchaseTransaction

func (*UserEvent) GetReferrerUri

func (x *UserEvent) GetReferrerUri() string

func (*UserEvent) GetSearchQuery

func (x *UserEvent) GetSearchQuery() string

func (*UserEvent) GetSessionId

func (x *UserEvent) GetSessionId() string

func (*UserEvent) GetUri

func (x *UserEvent) GetUri() string

func (*UserEvent) GetUserInfo

func (x *UserEvent) GetUserInfo() *UserInfo

func (*UserEvent) GetVisitorId

func (x *UserEvent) GetVisitorId() string

func (*UserEvent) ProtoMessage

func (*UserEvent) ProtoMessage()

func (*UserEvent) ProtoReflect

func (x *UserEvent) ProtoReflect() protoreflect.Message

func (*UserEvent) Reset

func (x *UserEvent) Reset()

func (*UserEvent) String

func (x *UserEvent) String() string

UserEventImportSummary

type UserEventImportSummary struct {

	// Count of user events imported with complete existing catalog information.
	JoinedEventsCount int64 `protobuf:"varint,1,opt,name=joined_events_count,json=joinedEventsCount,proto3" json:"joined_events_count,omitempty"`
	// Count of user events imported, but with catalog information not found
	// in the imported catalog.
	UnjoinedEventsCount int64 `protobuf:"varint,2,opt,name=unjoined_events_count,json=unjoinedEventsCount,proto3" json:"unjoined_events_count,omitempty"`
	// contains filtered or unexported fields
}

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

func (*UserEventImportSummary) Descriptor

func (*UserEventImportSummary) Descriptor() ([]byte, []int)

Deprecated: Use UserEventImportSummary.ProtoReflect.Descriptor instead.

func (*UserEventImportSummary) GetJoinedEventsCount

func (x *UserEventImportSummary) GetJoinedEventsCount() int64

func (*UserEventImportSummary) GetUnjoinedEventsCount

func (x *UserEventImportSummary) GetUnjoinedEventsCount() int64

func (*UserEventImportSummary) ProtoMessage

func (*UserEventImportSummary) ProtoMessage()

func (*UserEventImportSummary) ProtoReflect

func (x *UserEventImportSummary) ProtoReflect() protoreflect.Message

func (*UserEventImportSummary) Reset

func (x *UserEventImportSummary) Reset()

func (*UserEventImportSummary) String

func (x *UserEventImportSummary) String() string

UserEventInlineSource

type UserEventInlineSource struct {

	// Required. A list of user events to import. Recommended max of 10k items.
	UserEvents []*UserEvent `protobuf:"bytes,1,rep,name=user_events,json=userEvents,proto3" json:"user_events,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for ImportUserEvents method.

func (*UserEventInlineSource) Descriptor

func (*UserEventInlineSource) Descriptor() ([]byte, []int)

Deprecated: Use UserEventInlineSource.ProtoReflect.Descriptor instead.

func (*UserEventInlineSource) GetUserEvents

func (x *UserEventInlineSource) GetUserEvents() []*UserEvent

func (*UserEventInlineSource) ProtoMessage

func (*UserEventInlineSource) ProtoMessage()

func (*UserEventInlineSource) ProtoReflect

func (x *UserEventInlineSource) ProtoReflect() protoreflect.Message

func (*UserEventInlineSource) Reset

func (x *UserEventInlineSource) Reset()

func (*UserEventInlineSource) String

func (x *UserEventInlineSource) String() string

UserEventInputConfig

type UserEventInputConfig struct {

	// The source of the input.
	//
	// Types that are assignable to Source:
	//
	//	*UserEventInputConfig_UserEventInlineSource
	//	*UserEventInputConfig_GcsSource
	//	*UserEventInputConfig_BigQuerySource
	Source isUserEventInputConfig_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

The input config source for user events.

func (*UserEventInputConfig) Descriptor

func (*UserEventInputConfig) Descriptor() ([]byte, []int)

Deprecated: Use UserEventInputConfig.ProtoReflect.Descriptor instead.

func (*UserEventInputConfig) GetBigQuerySource

func (x *UserEventInputConfig) GetBigQuerySource() *BigQuerySource

func (*UserEventInputConfig) GetGcsSource

func (x *UserEventInputConfig) GetGcsSource() *GcsSource

func (*UserEventInputConfig) GetSource

func (m *UserEventInputConfig) GetSource() isUserEventInputConfig_Source

func (*UserEventInputConfig) GetUserEventInlineSource

func (x *UserEventInputConfig) GetUserEventInlineSource() *UserEventInlineSource

func (*UserEventInputConfig) ProtoMessage

func (*UserEventInputConfig) ProtoMessage()

func (*UserEventInputConfig) ProtoReflect

func (x *UserEventInputConfig) ProtoReflect() protoreflect.Message

func (*UserEventInputConfig) Reset

func (x *UserEventInputConfig) Reset()

func (*UserEventInputConfig) String

func (x *UserEventInputConfig) String() string

UserEventInputConfig_BigQuerySource

type UserEventInputConfig_BigQuerySource struct {
	// Required. BigQuery input source.
	BigQuerySource *BigQuerySource `protobuf:"bytes,3,opt,name=big_query_source,json=bigQuerySource,proto3,oneof"`
}

UserEventInputConfig_GcsSource

type UserEventInputConfig_GcsSource struct {
	// Required. Google Cloud Storage location for the input content.
	GcsSource *GcsSource `protobuf:"bytes,2,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

UserEventInputConfig_UserEventInlineSource

type UserEventInputConfig_UserEventInlineSource struct {
	// Required. The Inline source for the input content for UserEvents.
	UserEventInlineSource *UserEventInlineSource `protobuf:"bytes,1,opt,name=user_event_inline_source,json=userEventInlineSource,proto3,oneof"`
}

UserEventServiceClient

type UserEventServiceClient interface {
	// Writes a single user event.
	WriteUserEvent(ctx context.Context, in *WriteUserEventRequest, opts ...grpc.CallOption) (*UserEvent, error)
	// Writes a single user event from the browser. This uses a GET request to
	// due to browser restriction of POST-ing to a 3rd party domain.
	//
	// This method is used only by the Retail API JavaScript pixel and Google Tag
	// Manager. Users should not call this method directly.
	CollectUserEvent(ctx context.Context, in *CollectUserEventRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, error)
	// Deletes permanently all user events specified by the filter provided.
	// Depending on the number of events specified by the filter, this operation
	// could take hours or days to complete. To test a filter, use the list
	// command first.
	PurgeUserEvents(ctx context.Context, in *PurgeUserEventsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Bulk import of User events. Request processing might be
	// synchronous. Events that already exist are skipped.
	// Use this method for backfilling historical user events.
	//
	// `Operation.response` is of type `ImportResponse`. Note that it is
	// possible for a subset of the items to be successfully inserted.
	// `Operation.metadata` is of type `ImportMetadata`.
	ImportUserEvents(ctx context.Context, in *ImportUserEventsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Starts a user-event rejoin operation with latest product catalog. Events
	// are not annotated with detailed product information for products that are
	// missing from the catalog when the user event is ingested. These
	// events are stored as unjoined events with limited usage on training and
	// serving. You can use this method to start a join operation on specified
	// events with the latest version of product catalog. You can also use this
	// method to correct events joined with the wrong product catalog. A rejoin
	// operation can take hours or days to complete.
	RejoinUserEvents(ctx context.Context, in *RejoinUserEventsRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

UserEventServiceClient is the client API for UserEventService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewUserEventServiceClient

func NewUserEventServiceClient(cc grpc.ClientConnInterface) UserEventServiceClient

UserEventServiceServer

type UserEventServiceServer interface {
	// Writes a single user event.
	WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)
	// Writes a single user event from the browser. This uses a GET request to
	// due to browser restriction of POST-ing to a 3rd party domain.
	//
	// This method is used only by the Retail API JavaScript pixel and Google Tag
	// Manager. Users should not call this method directly.
	CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)
	// Deletes permanently all user events specified by the filter provided.
	// Depending on the number of events specified by the filter, this operation
	// could take hours or days to complete. To test a filter, use the list
	// command first.
	PurgeUserEvents(context.Context, *PurgeUserEventsRequest) (*longrunningpb.Operation, error)
	// Bulk import of User events. Request processing might be
	// synchronous. Events that already exist are skipped.
	// Use this method for backfilling historical user events.
	//
	// `Operation.response` is of type `ImportResponse`. Note that it is
	// possible for a subset of the items to be successfully inserted.
	// `Operation.metadata` is of type `ImportMetadata`.
	ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunningpb.Operation, error)
	// Starts a user-event rejoin operation with latest product catalog. Events
	// are not annotated with detailed product information for products that are
	// missing from the catalog when the user event is ingested. These
	// events are stored as unjoined events with limited usage on training and
	// serving. You can use this method to start a join operation on specified
	// events with the latest version of product catalog. You can also use this
	// method to correct events joined with the wrong product catalog. A rejoin
	// operation can take hours or days to complete.
	RejoinUserEvents(context.Context, *RejoinUserEventsRequest) (*longrunningpb.Operation, error)
}

UserEventServiceServer is the server API for UserEventService service.

UserInfo

type UserInfo struct {

	// Highly recommended for logged-in users. Unique identifier for logged-in
	// user, such as a user name. Don't set for anonymous users.
	//
	// Always use a hashed value for this ID.
	//
	// Don't set the field to the same fixed ID for different users. This mixes
	// the event history of those users together, which results in degraded
	// model quality.
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// The end user's IP address. This field is used to extract location
	// information for personalization.
	//
	// This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
	// address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
	// INVALID_ARGUMENT error is returned.
	//
	// This should not be set when:
	//
	// * setting
	// [SearchRequest.user_info][google.cloud.retail.v2beta.SearchRequest.user_info].
	// * using the JavaScript tag in
	// [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent]
	// or if
	// [direct_user_request][google.cloud.retail.v2beta.UserInfo.direct_user_request]
	// is set.
	IpAddress string `protobuf:"bytes,2,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`
	// User agent as included in the HTTP header. Required for getting
	// [SearchResponse.sponsored_results][google.cloud.retail.v2beta.SearchResponse.sponsored_results].
	//
	// The field must be a UTF-8 encoded string with a length limit of 1,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// This should not be set when using the client side event reporting with
	// GTM or JavaScript tag in
	// [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent]
	// or if
	// [direct_user_request][google.cloud.retail.v2beta.UserInfo.direct_user_request]
	// is set.
	UserAgent string `protobuf:"bytes,3,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
	// True if the request is made directly from the end user, in which case the
	// [ip_address][google.cloud.retail.v2beta.UserInfo.ip_address] and
	// [user_agent][google.cloud.retail.v2beta.UserInfo.user_agent] can be
	// populated from the HTTP request. This flag should be set only if the API
	// request is made directly from the end user such as a mobile app (and not if
	// a gateway or a server is processing and pushing the user events).
	//
	// This should not be set when using the JavaScript tag in
	// [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent].
	DirectUserRequest bool `protobuf:"varint,4,opt,name=direct_user_request,json=directUserRequest,proto3" json:"direct_user_request,omitempty"`
	// contains filtered or unexported fields
}

Information of an end user.

func (*UserInfo) Descriptor

func (*UserInfo) Descriptor() ([]byte, []int)

Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.

func (*UserInfo) GetDirectUserRequest

func (x *UserInfo) GetDirectUserRequest() bool

func (*UserInfo) GetIpAddress

func (x *UserInfo) GetIpAddress() string

func (*UserInfo) GetUserAgent

func (x *UserInfo) GetUserAgent() string

func (*UserInfo) GetUserId

func (x *UserInfo) GetUserId() string

func (*UserInfo) ProtoMessage

func (*UserInfo) ProtoMessage()

func (*UserInfo) ProtoReflect

func (x *UserInfo) ProtoReflect() protoreflect.Message

func (*UserInfo) Reset

func (x *UserInfo) Reset()

func (*UserInfo) String

func (x *UserInfo) String() string

WriteUserEventRequest

type WriteUserEventRequest struct {

	// Required. The parent catalog resource name, such as
	// `projects/1234/locations/global/catalogs/default_catalog`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. User event to write.
	UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
	// If set to true, the user event will be written asynchronously after
	// validation, and the API will respond without waiting for the write.
	// Therefore, silent failures can occur even if the API returns success. In
	// case of silent failures, error messages can be found in Stackdriver logs.
	WriteAsync bool `protobuf:"varint,3,opt,name=write_async,json=writeAsync,proto3" json:"write_async,omitempty"`
	// contains filtered or unexported fields
}

Request message for WriteUserEvent method.

func (*WriteUserEventRequest) Descriptor

func (*WriteUserEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use WriteUserEventRequest.ProtoReflect.Descriptor instead.

func (*WriteUserEventRequest) GetParent

func (x *WriteUserEventRequest) GetParent() string

func (*WriteUserEventRequest) GetUserEvent

func (x *WriteUserEventRequest) GetUserEvent() *UserEvent

func (*WriteUserEventRequest) GetWriteAsync

func (x *WriteUserEventRequest) GetWriteAsync() bool

func (*WriteUserEventRequest) ProtoMessage

func (*WriteUserEventRequest) ProtoMessage()

func (*WriteUserEventRequest) ProtoReflect

func (x *WriteUserEventRequest) ProtoReflect() protoreflect.Message

func (*WriteUserEventRequest) Reset

func (x *WriteUserEventRequest) Reset()

func (*WriteUserEventRequest) String

func (x *WriteUserEventRequest) String() string