target.apidocs.com.google.api.services.pubsub.model.Expr.html Maven / Gradle / Ivy
Expr (Cloud Pub/Sub API v1-rev20240918-2.0.0)
com.google.api.services.pubsub.model
Class Expr
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.pubsub.model.Expr
-
public final class Expr
extends com.google.api.client.json.GenericJson
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Expr()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Exprclone()
StringgetDescription()
Optional.
StringgetExpression()
Textual representation of an expression in Common Expression Language syntax.
StringgetLocation()
Optional.
StringgetTitle()
Optional.
Exprset(String fieldName,
Object value)
ExprsetDescription(String description)
Optional.
ExprsetExpression(String expression)
Textual representation of an expression in Common Expression Language syntax.
ExprsetLocation(String location)
Optional.
ExprsetTitle(String title)
Optional.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getDescription
public String getDescription()
Optional. Description of the expression. This is a longer text which describes the expression,
e.g. when hovered over it in a UI.
- Returns:
- value or
null for none
-
setDescription
public Expr setDescription(String description)
Optional. Description of the expression. This is a longer text which describes the expression,
e.g. when hovered over it in a UI.
- Parameters:
description - description or null for none
-
getExpression
public String getExpression()
Textual representation of an expression in Common Expression Language syntax.
- Returns:
- value or
null for none
-
setExpression
public Expr setExpression(String expression)
Textual representation of an expression in Common Expression Language syntax.
- Parameters:
expression - expression or null for none
-
getLocation
public String getLocation()
Optional. String indicating the location of the expression for error reporting, e.g. a file
name and a position in the file.
- Returns:
- value or
null for none
-
setLocation
public Expr setLocation(String location)
Optional. String indicating the location of the expression for error reporting, e.g. a file
name and a position in the file.
- Parameters:
location - location or null for none
-
getTitle
public String getTitle()
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.
- Returns:
- value or
null for none
-
setTitle
public Expr setTitle(String title)
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.
- Parameters:
title - title or null for none
-
set
public Expr set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public Expr clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.