public final class LabelPropertiesPattern extends GeneratedMessage implements LabelPropertiesPatternOrBuilderMatcher for label and property. The matcher accepts both exact match and expression.
Protobuf type google.cloud.apptopology.v1.LabelPropertiesPattern
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > LabelPropertiesPatternImplements
LabelPropertiesPatternOrBuilderStatic Fields
LABEL_MATCHER_EXPR_FIELD_NUMBER
public static final int LABEL_MATCHER_EXPR_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROPERTY_MATCHER_EXPR_FIELD_NUMBER
public static final int PROPERTY_MATCHER_EXPR_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static LabelPropertiesPattern getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static LabelPropertiesPattern.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern.Builder |
|
newBuilder(LabelPropertiesPattern prototype)
public static LabelPropertiesPattern.Builder newBuilder(LabelPropertiesPattern prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
LabelPropertiesPattern |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern.Builder |
|
parseDelimitedFrom(InputStream input)
public static LabelPropertiesPattern parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LabelPropertiesPattern parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static LabelPropertiesPattern parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LabelPropertiesPattern parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static LabelPropertiesPattern parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LabelPropertiesPattern parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static LabelPropertiesPattern parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LabelPropertiesPattern parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static LabelPropertiesPattern parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LabelPropertiesPattern parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static LabelPropertiesPattern parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LabelPropertiesPattern parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<LabelPropertiesPattern> parser()| Returns | |
|---|---|
| Type | Description |
Parser<LabelPropertiesPattern> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public LabelPropertiesPattern getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern |
|
getLabelMatcherExpr()
public String getLabelMatcherExpr()Required. Matcher expression for labels. Allow OR / AND operators; The syntax is defined by the following grammar:
- The label expression can use either
ORorANDoperator, but not a combination of both. Example:AppHub/Application,AppHub/Workload OR AppHub/Service
string label_matcher_expr = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The labelMatcherExpr. |
getLabelMatcherExprBytes()
public ByteString getLabelMatcherExprBytes()Required. Matcher expression for labels. Allow OR / AND operators; The syntax is defined by the following grammar:
- The label expression can use either
ORorANDoperator, but not a combination of both. Example:AppHub/Application,AppHub/Workload OR AppHub/Service
string label_matcher_expr = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for labelMatcherExpr. |
getParserForType()
public Parser<LabelPropertiesPattern> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<LabelPropertiesPattern> |
|
getPropertyMatcherExpr()
public String getPropertyMatcherExpr()Optional. The syntax of the filter is defined by the following grammar: https://google.aip.dev/160.
Referencing properties of graph elements using traversal operator ..
Repeated properties cannot be traversed.
e.g. e.NodeName, where e is a node or edge alias.
The following properties are supported for all node and edge types:
Labels: repeated string property. Can be used to combine conditions between labels and properties. e.g.e.Labels : "label_1"to match a node/edge with labellabel_1.NodeName/EdgeName: string property. Support for filtering by node or edge names. e.g.app.NodeName = "apphub.io/Application"Other properties types can be found at https://apptopology.googleapis.com/v1/GetSchema
The following operators are supported on properties:
- Checking if a non-repeated property of a graph element is equal to a
scalar value using the equality operator
=. - LHS must be a node/edge property.
- RHS must be a scalar literal.
Supported value types: string (enclosed in double quotes), int, double, and boolean. e.g.
e.project = "project_1"Checking if a non-repeated property of a graph element satisfies a condition using the comparison operators
>,<,>=,<=.- LHS must be a node/edge property.
- RHS must be a scalar literal.
Supported value types: string (enclosed in double quotes), int, double. e.g.
e.NumericProperty < 0.1Checking if a scalar value is present in a repeated property HAS operator
:.- LHS must be a repeated property.
- RHS must be a scalar literal.
Supported value types: string (enclosed in double quotes), int, double. e.g.
e.Labels : "label_1", wheree.Labelsis a repeated string property.Checking if a property is present using HAS_PROPERTY operator
:.- LHS must be a node or edge alias.
RHS must be a property name. e.g.
e : Base/Location, whereeis a node or edge alias.Combining multiple filters using logical operators :
AND, andOR.Parentheses must be used to resolve ambiguity. e.g.
e.Base/Location = "us-central1" AND e.project = "project_1"The following custom functions are supported:
- EQUALS_ANY(arg1, arg2, arg3, ...)
- Checks if
arg1(a non-repeated property) equals any of the subsequent scalar literal arguments. - arg1: non-repeated property. Supported value types: string (enclosed in double quotes), int, double.
- arg2, arg3, ...: The remaining arguments are literal values to compare against. All the arguments must be of the same type.
e.g.
EQUALS_ANY(e.project, "project_1", "project_2")CONTAINS_ANY(arg1, arg2, arg3, ...)
- Checks if a repeated property has any of the given scalar literals. arg1: repeated_property. Supported element types: string (enclosed in double quotes), int, double.
- arg2, arg3, ...: The remaining arguments are literal values to compare against. All the arguments must be of the same type.
e.g.
CONTAINS_ANY(e.folders, "folder_1", "folder_2")CONTAINS_ANY_LESS_THAN(arg1, arg2)
- Checks if a repeated property has any element less than the given scalar literal.
- arg1: repeated_property. Supported element types are: int, double.
- arg2: scalar literal
e.g.
CONTAINS_ANY_LESS_THAN(e.NumericProperty, 0.1)CONTAINS_ANY_GREATER_THAN(arg1, arg2)
- Checks if a repeated property has any element greater than the given scalar literal.
- arg1: repeated_property. Supported element types are: int, double.
- arg2: scalar literal
e.g.
CONTAINS_ANY_GREATER_THAN(e.NumericProperty, 0.1)CONTAINS_ANY_LESS_OR_EQUAL(arg1, arg2)
- Checks if a repeated property has any element less than or equal to the given scalar literal.
- arg1: repeated_property. Supported element types are: int, double.
- arg2: scalar literal
e.g.
CONTAINS_ANY_LESS_OR_EQUAL(e.NumericProperty, 0.1)CONTAINS_ANY_GREATER_OR_EQUAL(arg1, arg2)
- Checks if a repeated property has any element greater than or equal to the given scalar literal.
- arg1: repeated_property. Supported element types are: int, double.
- arg2: scalar literal
e.g.
CONTAINS_ANY_GREATER_OR_EQUAL(e.NumericProperty, 0.1)NOTE:
- For Alert nodes, only the equality operator
=is supported. The expression cannot be a composite boolean expression (i.e., combining multiple conditions with AND/OR is not supported; it must be simple). e.g.a.NodeName = "alert-1"is supported, buta.NodeName = "alert-1" OR a.NodeName = "alert-2"is not supported. - For traffic edges, filters cannot be added.
string property_matcher_expr = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The propertyMatcherExpr. |
getPropertyMatcherExprBytes()
public ByteString getPropertyMatcherExprBytes()Optional. The syntax of the filter is defined by the following grammar: https://google.aip.dev/160.
Referencing properties of graph elements using traversal operator ..
Repeated properties cannot be traversed.
e.g. e.NodeName, where e is a node or edge alias.
The following properties are supported for all node and edge types:
Labels: repeated string property. Can be used to combine conditions between labels and properties. e.g.e.Labels : "label_1"to match a node/edge with labellabel_1.NodeName/EdgeName: string property. Support for filtering by node or edge names. e.g.app.NodeName = "apphub.io/Application"Other properties types can be found at https://apptopology.googleapis.com/v1/GetSchema
The following operators are supported on properties:
- Checking if a non-repeated property of a graph element is equal to a
scalar value using the equality operator
=. - LHS must be a node/edge property.
- RHS must be a scalar literal.
Supported value types: string (enclosed in double quotes), int, double, and boolean. e.g.
e.project = "project_1"Checking if a non-repeated property of a graph element satisfies a condition using the comparison operators
>,<,>=,<=.- LHS must be a node/edge property.
- RHS must be a scalar literal.
Supported value types: string (enclosed in double quotes), int, double. e.g.
e.NumericProperty < 0.1Checking if a scalar value is present in a repeated property HAS operator
:.- LHS must be a repeated property.
- RHS must be a scalar literal.
Supported value types: string (enclosed in double quotes), int, double. e.g.
e.Labels : "label_1", wheree.Labelsis a repeated string property.Checking if a property is present using HAS_PROPERTY operator
:.- LHS must be a node or edge alias.
RHS must be a property name. e.g.
e : Base/Location, whereeis a node or edge alias.Combining multiple filters using logical operators :
AND, andOR.Parentheses must be used to resolve ambiguity. e.g.
e.Base/Location = "us-central1" AND e.project = "project_1"The following custom functions are supported:
- EQUALS_ANY(arg1, arg2, arg3, ...)
- Checks if
arg1(a non-repeated property) equals any of the subsequent scalar literal arguments. - arg1: non-repeated property. Supported value types: string (enclosed in double quotes), int, double.
- arg2, arg3, ...: The remaining arguments are literal values to compare against. All the arguments must be of the same type.
e.g.
EQUALS_ANY(e.project, "project_1", "project_2")CONTAINS_ANY(arg1, arg2, arg3, ...)
- Checks if a repeated property has any of the given scalar literals. arg1: repeated_property. Supported element types: string (enclosed in double quotes), int, double.
- arg2, arg3, ...: The remaining arguments are literal values to compare against. All the arguments must be of the same type.
e.g.
CONTAINS_ANY(e.folders, "folder_1", "folder_2")CONTAINS_ANY_LESS_THAN(arg1, arg2)
- Checks if a repeated property has any element less than the given scalar literal.
- arg1: repeated_property. Supported element types are: int, double.
- arg2: scalar literal
e.g.
CONTAINS_ANY_LESS_THAN(e.NumericProperty, 0.1)CONTAINS_ANY_GREATER_THAN(arg1, arg2)
- Checks if a repeated property has any element greater than the given scalar literal.
- arg1: repeated_property. Supported element types are: int, double.
- arg2: scalar literal
e.g.
CONTAINS_ANY_GREATER_THAN(e.NumericProperty, 0.1)CONTAINS_ANY_LESS_OR_EQUAL(arg1, arg2)
- Checks if a repeated property has any element less than or equal to the given scalar literal.
- arg1: repeated_property. Supported element types are: int, double.
- arg2: scalar literal
e.g.
CONTAINS_ANY_LESS_OR_EQUAL(e.NumericProperty, 0.1)CONTAINS_ANY_GREATER_OR_EQUAL(arg1, arg2)
- Checks if a repeated property has any element greater than or equal to the given scalar literal.
- arg1: repeated_property. Supported element types are: int, double.
- arg2: scalar literal
e.g.
CONTAINS_ANY_GREATER_OR_EQUAL(e.NumericProperty, 0.1)NOTE:
- For Alert nodes, only the equality operator
=is supported. The expression cannot be a composite boolean expression (i.e., combining multiple conditions with AND/OR is not supported; it must be simple). e.g.a.NodeName = "alert-1"is supported, buta.NodeName = "alert-1" OR a.NodeName = "alert-2"is not supported. - For traffic edges, filters cannot be added.
string property_matcher_expr = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for propertyMatcherExpr. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public LabelPropertiesPattern.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected LabelPropertiesPattern.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern.Builder |
|
toBuilder()
public LabelPropertiesPattern.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
LabelPropertiesPattern.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|