EventGridClient Interface

Package:

com.microsoft.azure.eventgrid

Maven Artifact:

com.microsoft.azure:azure-eventgrid:1.3.0

public interface EventGridClient

The interface for EventGridClient class.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	acceptLanguage() Gets Gets or sets the preferred language for the response..
abstract java.lang.String	apiVersion() Gets Version of the API to be used with the client request..
abstract boolean	generateClientRequestId() Gets When set to true a unique x-ms-client-request-id value is generated and included in each request.
abstract com.microsoft.azure.AzureClient	getAzureClient() Gets the AzureClient used for long running operations.
abstract int	longRunningOperationRetryTimeout() Gets Gets or sets the retry timeout in seconds for Long Running Operations.
abstract void	publishEvents(String topicHostname, List<EventGridEvent> events) Publishes a batch of events to an Azure Event Grid topic.
abstract rx.Observable<java.lang.Void>	publishEventsAsync(String topicHostname, List<EventGridEvent> events) Publishes a batch of events to an Azure Event Grid topic.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	publishEventsAsync(String topicHostname, List<EventGridEvent> events, ServiceCallback<Void> serviceCallback) Publishes a batch of events to an Azure Event Grid topic.
abstract rx.Observable<com.microsoft.rest.ServiceResponse<java.lang.Void>>	publishEventsWithServiceResponseAsync(String topicHostname, List<EventGridEvent> events) Publishes a batch of events to an Azure Event Grid topic.
abstract com.microsoft.rest.RestClient	restClient() Gets the REST client.
abstract java.lang.String	userAgent() Gets the User-Agent header for the client.
abstract EventGridClient	withAcceptLanguage(String acceptLanguage) Sets Gets or sets the preferred language for the response..
abstract EventGridClient	withGenerateClientRequestId(boolean generateClientRequestId) Sets When set to true a unique x-ms-client-request-id value is generated and included in each request.
abstract EventGridClient	withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout) Sets Gets or sets the retry timeout in seconds for Long Running Operations.

Method Details

acceptLanguage

public abstract String acceptLanguage()

Gets Gets or sets the preferred language for the response..

Returns:

the acceptLanguage value.

apiVersion

public abstract String apiVersion()

Gets Version of the API to be used with the client request..

Returns:

the apiVersion value.

generateClientRequestId

public abstract boolean generateClientRequestId()

Gets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true..

Returns:

the generateClientRequestId value.

getAzureClient

public abstract AzureClient getAzureClient()

Gets the AzureClient used for long running operations.

Returns:

the azure client;

longRunningOperationRetryTimeout

public abstract int longRunningOperationRetryTimeout()

Gets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..

Returns:

the longRunningOperationRetryTimeout value.

publishEvents

public abstract void publishEvents(String topicHostname, List<EventGridEvent> events)

Publishes a batch of events to an Azure Event Grid topic.

Parameters:

topicHostname - The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net

events - An array of events to be published to Event Grid.

publishEventsAsync

public abstract Observable<Void> publishEventsAsync(String topicHostname, List<EventGridEvent> events)

Publishes a batch of events to an Azure Event Grid topic.

Parameters:

topicHostname - The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net

events - An array of events to be published to Event Grid.

Returns:

the ServiceResponse object if successful.

publishEventsAsync

public abstract ServiceFuture<Void> publishEventsAsync(String topicHostname, List<EventGridEvent> events, ServiceCallback<Void> serviceCallback)

Publishes a batch of events to an Azure Event Grid topic.

Parameters:

topicHostname - The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net

events - An array of events to be published to Event Grid.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

publishEventsWithServiceResponseAsync

public abstract Observable<ServiceResponse<Void>> publishEventsWithServiceResponseAsync(String topicHostname, List<EventGridEvent> events)

Publishes a batch of events to an Azure Event Grid topic.

Parameters:

topicHostname - The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net

events - An array of events to be published to Event Grid.

Returns:

the ServiceResponse object if successful.

restClient

public abstract RestClient restClient()

Gets the REST client.

Returns:

the RestClient object.

userAgent

public abstract String userAgent()

Gets the User-Agent header for the client.

Returns:

the user agent string.

withAcceptLanguage

public abstract EventGridClient withAcceptLanguage(String acceptLanguage)

Sets Gets or sets the preferred language for the response..

Parameters:

acceptLanguage - the acceptLanguage value.

Returns:

the service client itself

withGenerateClientRequestId

public abstract EventGridClient withGenerateClientRequestId(boolean generateClientRequestId)

Sets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true..

Parameters:

generateClientRequestId - the generateClientRequestId value.

Returns:

the service client itself

withLongRunningOperationRetryTimeout

public abstract EventGridClient withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)

Sets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30..

Parameters:

longRunningOperationRetryTimeout - the longRunningOperationRetryTimeout value.

Returns:

the service client itself