EventNameFilter Class

Package:

com.azure.resourcemanager.webpubsub.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-webpubsub:1.1.0

• java.lang.Object
• • com.azure.resourcemanager.webpubsub.models.EventListenerFilter
  • • com.azure.resourcemanager.webpubsub.models.EventNameFilter

public final class EventNameFilter
extends EventListenerFilter

Filter events by their name.

Constructor Summary

Constructor	Description
EventNameFilter()	Creates an instance of EventNameFilter class.

Method Summary

Modifier and Type	Method and Description
static EventNameFilter	fromJson(JsonReader jsonReader) Reads an instance of EventNameFilter from the JsonReader.
List<String>	systemEvents() Get the systemEvents property: Gets or sets a list of system events.
JsonWriter	toJson(JsonWriter jsonWriter)
EventListenerFilterDiscriminator	type() Get the type property: The type property.
String	userEventPattern() Get the userEventPattern property: Gets or sets a matching pattern for event names.
void	validate() Validates the instance.
EventNameFilter	withSystemEvents(List<String> systemEvents) Set the systemEvents property: Gets or sets a list of system events.
EventNameFilter	withUserEventPattern(String userEventPattern) Set the userEventPattern property: Gets or sets a matching pattern for event names.

Methods inherited from EventListenerFilter

fromJson toJson type validate

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

EventNameFilter

public EventNameFilter()

Creates an instance of EventNameFilter class.

Method Details

fromJson

public static EventNameFilter fromJson(JsonReader jsonReader)

Reads an instance of EventNameFilter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of EventNameFilter if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the EventNameFilter.

systemEvents

public List<String> systemEvents()

Get the systemEvents property: Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.

Returns:

the systemEvents value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

EventNameFilter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public EventListenerFilterDiscriminator type()

Get the type property: The type property.

Overrides:

EventNameFilter.type()

Returns:

the type value.

userEventPattern

public String userEventPattern()

Get the userEventPattern property: Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1".

Returns:

the userEventPattern value.

validate

public void validate()

Validates the instance.

Overrides:

EventNameFilter.validate()

withSystemEvents

public EventNameFilter withSystemEvents(List<String> systemEvents)

Set the systemEvents property: Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.

Parameters:

systemEvents - the systemEvents value to set.

Returns:

the EventNameFilter object itself.

withUserEventPattern

public EventNameFilter withUserEventPattern(String userEventPattern)

Set the userEventPattern property: Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1".

Parameters:

userEventPattern - the userEventPattern value to set.

Returns:

the EventNameFilter object itself.