Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRequirement

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

Overview

A data requirement.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaRequirement

Returns a new instance of GoogleCloudDiscoveryengineV1alphaRequirement.



14147
14148
14149
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14147

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

Instance Attribute Details

#condition ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleTypeExpr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: " Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example ( Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. Corresponds to the JSON property condition

Returns:



14104
14105
14106
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14104

def condition
  @condition
end

#description ⇒ String

The description of the requirement. Corresponds to the JSON property description

Returns:

  • (String) 


14109
14110
14111
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14109

def description
  @description
end

#display_name ⇒ String

The name of the requirement. Corresponds to the JSON property displayName

Returns:

  • (String) 


14114
14115
14116
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14114

def display_name
  @display_name
end

#metric_bindings ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding>

A list of the metric bindings to be used in condition. Corresponds to the JSON property metricBindings

Returns:



14119
14120
14121
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14119

def metric_bindings
  @metric_bindings
end

#severity ⇒ Array<String>

The severity of errors if the requirement is not met. It must be ordered from the most strict to the least strict. Examples: * BLOCKING * CRITICAL * WARNING All thresholds in the requirement must have all the severity here. Corresponds to the JSON property severity

Returns:

  • (Array<String>) 


14126
14127
14128
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14126

def severity
  @severity
end

#threshold_bindings ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding>

A list of threshold bindings to be used in condition. Corresponds to the JSON property thresholdBindings

Returns:



14131
14132
14133
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14131

def threshold_bindings
  @threshold_bindings
end

#type ⇒ String

The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encouraged to use natural hierarchical grouping for similar requirements. Examples: * library. googleapis.com/books/min_available_books * discoveryengine.googleapis.com/ media_rec/recommended_for_you/conversion_rate Corresponds to the JSON property type

Returns:

  • (String) 


14140
14141
14142
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14140

def type
  @type
end

#violation_samples_bindings ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding>

A list of the metric bindings to be used in condition. Corresponds to the JSON property violationSamplesBindings

Returns:



14145
14146
14147
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14145

def violation_samples_bindings
  @violation_samples_bindings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14152

def update!(**args)
  @condition = args[:condition] if args.key?(:condition)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @metric_bindings = args[:metric_bindings] if args.key?(:metric_bindings)
  @severity = args[:severity] if args.key?(:severity)
  @threshold_bindings = args[:threshold_bindings] if args.key?(:threshold_bindings)
  @type = args[:type] if args.key?(:type)
  @violation_samples_bindings = args[:violation_samples_bindings] if args.key?(:violation_samples_bindings)
end