Class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig

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

Overview

Configuration for a Recommender.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommenderV1RecommenderConfig

Returns a new instance of GoogleCloudRecommenderV1RecommenderConfig.



836
837
838
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 836

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

Instance Attribute Details

#annotations ⇒ Hash<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>) 


798
799
800
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 798

def annotations
  @annotations
end

#display_name ⇒ String

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

Returns:

  • (String) 


804
805
806
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 804

def display_name
  @display_name
end

#etag ⇒ String

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

Returns:

  • (String) 


810
811
812
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 810

def etag
  @etag
end

#name ⇒ String

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

Returns:

  • (String) 


816
817
818
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 816

def name
  @name
end

#recommender_generation_config ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderGenerationConfig

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

Returns:



822
823
824
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 822

def recommender_generation_config
  @recommender_generation_config
end

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

Returns:

  • (String) 


829
830
831
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 829

def revision_id
  @revision_id
end

#update_time ⇒ String

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

Returns:

  • (String) 


834
835
836
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 834

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



841
842
843
844
845
846
847
848
849
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 841

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