Class: Google::Apis::BeyondcorpV1alpha::GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField

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

Overview

Field metadata. Commonly understandable name and description for the field. Multiple such fields constitute the Insight.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField

Returns a new instance of GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField.



2549
2550
2551
 
# File 'lib/google/apis/beyondcorp_v1alpha/classes.rb', line 2549

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

Instance Attribute Details

#description ⇒ String

Output only. Description of the field. Corresponds to the JSON property description

Returns:

  • (String) 


2518
2519
2520
 
# File 'lib/google/apis/beyondcorp_v1alpha/classes.rb', line 2518

def description
  @description
end

#display_name ⇒ String

Output only. Name of the field. Corresponds to the JSON property displayName

Returns:

  • (String) 


2523
2524
2525
 
# File 'lib/google/apis/beyondcorp_v1alpha/classes.rb', line 2523

def display_name
  @display_name
end

#filter_alias ⇒ String

Output only. Field name to be used in filter while requesting configured insight filtered on this field. Corresponds to the JSON property filterAlias

Returns:

  • (String) 


2529
2530
2531
 
# File 'lib/google/apis/beyondcorp_v1alpha/classes.rb', line 2529

def filter_alias
  @filter_alias
end

#filterable ⇒ Boolean Also known as: filterable?

Output only. Indicates whether the field can be used for filtering. Corresponds to the JSON property filterable

Returns:

  • (Boolean) 


2534
2535
2536
 
# File 'lib/google/apis/beyondcorp_v1alpha/classes.rb', line 2534

def filterable
  @filterable
end

#groupable ⇒ Boolean Also known as: groupable?

Output only. Indicates whether the field can be used for grouping in custom grouping request. Corresponds to the JSON property groupable

Returns:

  • (Boolean) 


2541
2542
2543
 
# File 'lib/google/apis/beyondcorp_v1alpha/classes.rb', line 2541

def groupable
  @groupable
end

#id ⇒ String

Output only. Field id for which this is the metadata. Corresponds to the JSON property id

Returns:

  • (String) 


2547
2548
2549
 
# File 'lib/google/apis/beyondcorp_v1alpha/classes.rb', line 2547

def id
  @id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2554
2555
2556
2557
2558
2559
2560
2561
 
# File 'lib/google/apis/beyondcorp_v1alpha/classes.rb', line 2554

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @filter_alias = args[:filter_alias] if args.key?(:filter_alias)
  @filterable = args[:filterable] if args.key?(:filterable)
  @groupable = args[:groupable] if args.key?(:groupable)
  @id = args[:id] if args.key?(:id)
end