Class: Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1RecommenderConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/recommender_v1beta1/classes.rb,
lib/google/apis/recommender_v1beta1/representations.rb,
lib/google/apis/recommender_v1beta1/representations.rb

Overview

Configuration for a Recommender.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommenderV1beta1RecommenderConfig

Returns a new instance of GoogleCloudRecommenderV1beta1RecommenderConfig.



1012
1013
1014
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 1012

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotationsHash<String,String>

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. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>)


974
975
976
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 974

def annotations
  @annotations
end

#display_nameString

A user-settable field to provide a human-readable name to be used in user interfaces. Corresponds to the JSON property displayName

Returns:

  • (String)


980
981
982
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 980

def display_name
  @display_name
end

#etagString

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating. Corresponds to the JSON property etag

Returns:

  • (String)


986
987
988
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 986

def etag
  @etag
end

#nameString

Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/ locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config Corresponds to the JSON property name

Returns:

  • (String)


992
993
994
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 992

def name
  @name
end

#recommender_generation_configGoogle::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1RecommenderGenerationConfig

A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation. Corresponds to the JSON property recommenderGenerationConfig



998
999
1000
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 998

def recommender_generation_config
  @recommender_generation_config
end

#revision_idString

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. Corresponds to the JSON property revisionId

Returns:

  • (String)


1005
1006
1007
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 1005

def revision_id
  @revision_id
end

#update_timeString

Last time when the config was updated. Corresponds to the JSON property updateTime

Returns:

  • (String)


1010
1011
1012
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 1010

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1017
1018
1019
1020
1021
1022
1023
1024
1025
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 1017

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @display_name = args[:display_name] if args.key?(:display_name)
  @etag = args[:etag] if args.key?(:etag)
  @name = args[:name] if args.key?(:name)
  @recommender_generation_config = args[:recommender_generation_config] if args.key?(:recommender_generation_config)
  @revision_id = args[:revision_id] if args.key?(:revision_id)
  @update_time = args[:update_time] if args.key?(:update_time)
end