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.



9157
9158
9159
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9157

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:



9121
9122
9123
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9121

def condition
  @condition
end

#description ⇒ String

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

Returns:

  • (String) 


9126
9127
9128
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9126

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


9131
9132
9133
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9131

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:



9136
9137
9138
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9136

def metric_bindings
  @metric_bindings
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:



9141
9142
9143
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9141

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


9150
9151
9152
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9150

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:



9155
9156
9157
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9155

def violation_samples_bindings
  @violation_samples_bindings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9162
9163
9164
9165
9166
9167
9168
9169
9170
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9162

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