Class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig

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 an InsightType.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommenderV1InsightTypeConfig

Returns a new instance of GoogleCloudRecommenderV1InsightTypeConfig.



279
280
281
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 279

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>) 


241
242
243
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 241

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) 


247
248
249
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 247

def display_name
  @display_name
end

#etag ⇒ String

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

Returns:

  • (String) 


253
254
255
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 253

def etag
  @etag
end

#insight_type_generation_config ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeGenerationConfig

A configuration to customize the generation of insights. Eg, customizing the lookback period considered when generating a insight. Corresponds to the JSON property insightTypeGenerationConfig

Returns:



259
260
261
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 259

def insight_type_generation_config
  @insight_type_generation_config
end

#name ⇒ String

Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION] /insightTypes/[INSIGHT_TYPE_ID]/config Corresponds to the JSON property name

Returns:

  • (String) 


265
266
267
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 265

def name
  @name
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) 


272
273
274
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 272

def revision_id
  @revision_id
end

#update_time ⇒ String

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

Returns:

  • (String) 


277
278
279
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 277

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



284
285
286
287
288
289
290
291
292
 
# File 'lib/google/apis/recommender_v1/classes.rb', line 284

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)
  @insight_type_generation_config = args[:insight_type_generation_config] if args.key?(:insight_type_generation_config)
  @name = args[:name] if args.key?(:name)
  @revision_id = args[:revision_id] if args.key?(:revision_id)
  @update_time = args[:update_time] if args.key?(:update_time)
end