Events Interface
public interface Events
An instance of this class provides access to all the operations defined in Events.
Method Summary
Method Details
get
public EventsResults get(String appId, EventType eventType, String eventId)
Get an event. Gets the data for a single event.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
eventId
- ID of event.
Returns:
the EventsResults object if successful.
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
ErrorResponseException
- thrown if the request is rejected by server
RuntimeException
- all other wrapped checked exceptions if the request fails to be sent
get
public EventsResults get(String appId, EventType eventType, String eventId, String timespan)
Get an event. Gets the data for a single event.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
eventId
- ID of event.
timespan
- Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.
Returns:
the EventsResults object if successful.
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
ErrorResponseException
- thrown if the request is rejected by server
RuntimeException
- all other wrapped checked exceptions if the request fails to be sent
getAsync
public Observable
Get an event. Gets the data for a single event.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
eventId
- ID of event.
Returns:
the observable to the EventsResults object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getAsync
public ServiceFuture
Get an event. Gets the data for a single event.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
eventId
- ID of event.
serviceCallback
- the async ServiceCallback to handle successful and failed responses.
Returns:
the ServiceFuture object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getAsync
public Observable
Get an event. Gets the data for a single event.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
eventId
- ID of event.
timespan
- Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.
Returns:
the observable to the EventsResults object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getAsync
public ServiceFuture
Get an event. Gets the data for a single event.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
eventId
- ID of event.
timespan
- Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.
serviceCallback
- the async ServiceCallback to handle successful and failed responses.
Returns:
the ServiceFuture object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getByType
public EventsResults getByType(String appId, EventType eventType)
Execute OData query. Executes an OData query for events.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
Returns:
the EventsResults object if successful.
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
ErrorResponseException
- thrown if the request is rejected by server
RuntimeException
- all other wrapped checked exceptions if the request fails to be sent
getByType
public EventsResults getByType(String appId, EventType eventType, String timespan, String filter, String search, String orderby, String select, Integer skip, Integer top, String format, Boolean count, String apply)
Execute OData query. Executes an OData query for events.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
timespan
- Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.
filter
- An expression used to filter the returned events
search
- A free-text search expression to match for whether a particular event should be returned
orderby
- A comma-separated list of properties with "asc" (the default) or "desc" to control the order of returned events
select
- Limits the properties to just those requested on each returned event
skip
- The number of items to skip over before returning events
top
- The number of events to return
format
- Format for the returned events
count
- Request a count of matching items included with the returned events
apply
- An expression used for aggregation over returned events
Returns:
the EventsResults object if successful.
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
ErrorResponseException
- thrown if the request is rejected by server
RuntimeException
- all other wrapped checked exceptions if the request fails to be sent
getByTypeAsync
public Observable
Execute OData query. Executes an OData query for events.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
Returns:
the observable to the EventsResults object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getByTypeAsync
public ServiceFuture
Execute OData query. Executes an OData query for events.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
serviceCallback
- the async ServiceCallback to handle successful and failed responses.
Returns:
the ServiceFuture object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getByTypeAsync
public Observable
Execute OData query. Executes an OData query for events.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
timespan
- Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.
filter
- An expression used to filter the returned events
search
- A free-text search expression to match for whether a particular event should be returned
orderby
- A comma-separated list of properties with "asc" (the default) or "desc" to control the order of returned events
select
- Limits the properties to just those requested on each returned event
skip
- The number of items to skip over before returning events
top
- The number of events to return
format
- Format for the returned events
count
- Request a count of matching items included with the returned events
apply
- An expression used for aggregation over returned events
Returns:
the observable to the EventsResults object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getByTypeAsync
public ServiceFuture
Execute OData query. Executes an OData query for events.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
timespan
- Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.
filter
- An expression used to filter the returned events
search
- A free-text search expression to match for whether a particular event should be returned
orderby
- A comma-separated list of properties with "asc" (the default) or "desc" to control the order of returned events
select
- Limits the properties to just those requested on each returned event
skip
- The number of items to skip over before returning events
top
- The number of events to return
format
- Format for the returned events
count
- Request a count of matching items included with the returned events
apply
- An expression used for aggregation over returned events
serviceCallback
- the async ServiceCallback to handle successful and failed responses.
Returns:
the ServiceFuture object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getByTypeWithServiceResponseAsync
public Observable
Execute OData query. Executes an OData query for events.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
Returns:
the observable to the EventsResults object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getByTypeWithServiceResponseAsync
public Observable
Execute OData query. Executes an OData query for events.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
timespan
- Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.
filter
- An expression used to filter the returned events
search
- A free-text search expression to match for whether a particular event should be returned
orderby
- A comma-separated list of properties with "asc" (the default) or "desc" to control the order of returned events
select
- Limits the properties to just those requested on each returned event
skip
- The number of items to skip over before returning events
top
- The number of events to return
format
- Format for the returned events
count
- Request a count of matching items included with the returned events
apply
- An expression used for aggregation over returned events
Returns:
the observable to the EventsResults object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getWithServiceResponseAsync
public Observable
Get an event. Gets the data for a single event.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
eventId
- ID of event.
Returns:
the observable to the EventsResults object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
getWithServiceResponseAsync
public Observable
Get an event. Gets the data for a single event.
Parameters:
appId
- ID of the application. This is Application ID from the API Access settings blade in the Azure portal.
eventType
- The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types. Possible values include: '$all', 'traces', 'customEvents', 'pageViews', 'browserTimings', 'requests', 'dependencies', 'exceptions', 'availabilityResults', 'performanceCounters', 'customMetrics'
eventId
- ID of event.
timespan
- Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.
Returns:
the observable to the EventsResults object
Throws:
IllegalArgumentException
- thrown if parameters fail the validation
Applies to
Spolupracujte s námi na GitHubu
Zdroj tohoto obsahu najdete na GitHubu, kde můžete také vytvářet a kontrolovat problémy a žádosti o přijetí změn. Další informace najdete v našem průvodci pro přispěvatele.
Azure SDK for Java