Recommender V1 Client - Class RecommenderConfig (2.0.5)

Reference documentation and code samples for the Recommender V1 Client class RecommenderConfig.

Configuration for a Recommender.

Generated from protobuf message google.cloud.recommender.v1.RecommenderConfig

Namespace

Google \ Cloud \ Recommender \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

↳ recommender_generation_config
RecommenderGenerationConfig

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

↳ etag
string

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

↳ update_time
Google\Protobuf\Timestamp

Last time when the config was updated.

↳ revision_id
string

Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.

↳ annotations
array| Google\Protobuf\Internal\MapField

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

↳ display_name
string

A user-settable field to provide a human-readable name to be used in user interfaces.

getName

Name of recommender config.

Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

Returns
Type
Description
string

setName

Name of recommender config.

Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getRecommenderGenerationConfig

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

Returns
Type
Description

hasRecommenderGenerationConfig

clearRecommenderGenerationConfig

setRecommenderGenerationConfig

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

Parameter
Name
Description
Returns
Type
Description
$this

getEtag

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

Returns
Type
Description
string

setEtag

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUpdateTime

Last time when the config was updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Last time when the config was updated.

Parameter
Name
Description
Returns
Type
Description
$this

getRevisionId

Output only. Immutable. The revision ID of the config.

A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.

Returns
Type
Description
string

setRevisionId

Output only. Immutable. The revision ID of the config.

A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAnnotations

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax.

The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

Returns
Type
Description

setAnnotations

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax.

The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

Parameter
Name
Description
Returns
Type
Description
$this

getDisplayName

A user-settable field to provide a human-readable name to be used in user interfaces.

Returns
Type
Description
string

setDisplayName

A user-settable field to provide a human-readable name to be used in user interfaces.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: