Class: Google::Apis::DiscoveryengineV1alpha::GoogleTypeExpr

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

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleTypeExpr

Returns a new instance of GoogleTypeExpr.



14372
14373
14374
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14372

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

Instance Attribute Details

#description ⇒ String

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. Corresponds to the JSON property description

Returns:

  • (String) 


14353
14354
14355
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14353

def description
  @description
end

#expression ⇒ String

Textual representation of an expression in Common Expression Language syntax. Corresponds to the JSON property expression

Returns:

  • (String) 


14358
14359
14360
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14358

def expression
  @expression
end

#location ⇒ String

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. Corresponds to the JSON property location

Returns:

  • (String) 


14364
14365
14366
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14364

def location
  @location
end

#title ⇒ String

Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. Corresponds to the JSON property title

Returns:

  • (String) 


14370
14371
14372
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14370

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14377
14378
14379
14380
14381
14382
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14377

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @expression = args[:expression] if args.key?(:expression)
  @location = args[:location] if args.key?(:location)
  @title = args[:title] if args.key?(:title)
end