222 строки
16 KiB
YAML
222 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.eventgrid.EventGridClient"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient"
|
|
name: "EventGridClient"
|
|
nameWithType: "EventGridClient"
|
|
summary: "The interface for Event<wbr>Grid<wbr>Client class."
|
|
syntax: "public interface **EventGridClient**"
|
|
methods:
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.acceptLanguage()"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.acceptLanguage()"
|
|
name: "acceptLanguage()"
|
|
nameWithType: "EventGridClient.acceptLanguage()"
|
|
summary: "Gets Gets or sets the preferred language for the response.."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String acceptLanguage()"
|
|
desc: "Gets Gets or sets the preferred language for the response.."
|
|
returns:
|
|
description: "the acceptLanguage value."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.apiVersion()"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.apiVersion()"
|
|
name: "apiVersion()"
|
|
nameWithType: "EventGridClient.apiVersion()"
|
|
summary: "Gets Version of the API to be used with the client request.."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String apiVersion()"
|
|
desc: "Gets Version of the API to be used with the client request.."
|
|
returns:
|
|
description: "the apiVersion value."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.generateClientRequestId()"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.generateClientRequestId()"
|
|
name: "generateClientRequestId()"
|
|
nameWithType: "EventGridClient.generateClientRequestId()"
|
|
summary: "Gets When set to true a unique x-ms-client-request-id value is generated and included in each request."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract boolean generateClientRequestId()"
|
|
desc: "Gets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.."
|
|
returns:
|
|
description: "the generateClientRequestId value."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.getAzureClient()"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.getAzureClient()"
|
|
name: "getAzureClient()"
|
|
nameWithType: "EventGridClient.getAzureClient()"
|
|
summary: "Gets the <xref uid=\"com.microsoft.azure.AzureClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureClient\"></xref> used for long running operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract AzureClient getAzureClient()"
|
|
desc: "Gets the <xref uid=\"com.microsoft.azure.AzureClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureClient\"></xref> used for long running operations."
|
|
returns:
|
|
description: "the azure client;"
|
|
type: "<xref href=\"com.microsoft.azure.AzureClient?alt=com.microsoft.azure.AzureClient&text=AzureClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.longRunningOperationRetryTimeout()"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.longRunningOperationRetryTimeout()"
|
|
name: "longRunningOperationRetryTimeout()"
|
|
nameWithType: "EventGridClient.longRunningOperationRetryTimeout()"
|
|
summary: "Gets Gets or sets the retry timeout in seconds for Long Running Operations."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract int longRunningOperationRetryTimeout()"
|
|
desc: "Gets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.."
|
|
returns:
|
|
description: "the longRunningOperationRetryTimeout value."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.publishEvents(java.lang.String,java.util.List<com.microsoft.azure.eventgrid.models.EventGridEvent>)"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.publishEvents(String topicHostname, List<EventGridEvent> events)"
|
|
name: "publishEvents(String topicHostname, List<EventGridEvent> events)"
|
|
nameWithType: "EventGridClient.publishEvents(String topicHostname, List<EventGridEvent> events)"
|
|
summary: "Publishes a batch of events to an Azure Event Grid topic."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net"
|
|
name: "topicHostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An array of events to be published to Event Grid."
|
|
name: "events"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.eventgrid.models.EventGridEvent?alt=com.microsoft.azure.eventgrid.models.EventGridEvent&text=EventGridEvent\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public abstract void publishEvents(String topicHostname, List<EventGridEvent> events)"
|
|
desc: "Publishes a batch of events to an Azure Event Grid topic."
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.publishEventsAsync(java.lang.String,java.util.List<com.microsoft.azure.eventgrid.models.EventGridEvent>)"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.publishEventsAsync(String topicHostname, List<EventGridEvent> events)"
|
|
name: "publishEventsAsync(String topicHostname, List<EventGridEvent> events)"
|
|
nameWithType: "EventGridClient.publishEventsAsync(String topicHostname, List<EventGridEvent> events)"
|
|
summary: "Publishes a batch of events to an Azure Event Grid topic."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net"
|
|
name: "topicHostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An array of events to be published to Event Grid."
|
|
name: "events"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.eventgrid.models.EventGridEvent?alt=com.microsoft.azure.eventgrid.models.EventGridEvent&text=EventGridEvent\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public abstract Observable<Void> publishEventsAsync(String topicHostname, List<EventGridEvent> events)"
|
|
desc: "Publishes a batch of events to an Azure Event Grid topic."
|
|
returns:
|
|
description: "the <xref uid=\"com.microsoft.rest.ServiceResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceResponse\"></xref> object if successful."
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.publishEventsAsync(java.lang.String,java.util.List<com.microsoft.azure.eventgrid.models.EventGridEvent>,com.microsoft.rest.ServiceCallback<java.lang.Void>)"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.publishEventsAsync(String topicHostname, List<EventGridEvent> events, ServiceCallback<Void> serviceCallback)"
|
|
name: "publishEventsAsync(String topicHostname, List<EventGridEvent> events, ServiceCallback<Void> serviceCallback)"
|
|
nameWithType: "EventGridClient.publishEventsAsync(String topicHostname, List<EventGridEvent> events, ServiceCallback<Void> serviceCallback)"
|
|
summary: "Publishes a batch of events to an Azure Event Grid topic."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net"
|
|
name: "topicHostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An array of events to be published to Event Grid."
|
|
name: "events"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.eventgrid.models.EventGridEvent?alt=com.microsoft.azure.eventgrid.models.EventGridEvent&text=EventGridEvent\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "the async ServiceCallback to handle successful and failed responses."
|
|
name: "serviceCallback"
|
|
type: "<xref href=\"com.microsoft.rest.ServiceCallback?alt=com.microsoft.rest.ServiceCallback&text=ServiceCallback\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public abstract ServiceFuture<Void> publishEventsAsync(String topicHostname, List<EventGridEvent> events, ServiceCallback<Void> serviceCallback)"
|
|
desc: "Publishes a batch of events to an Azure Event Grid topic."
|
|
returns:
|
|
description: "the <xref uid=\"com.microsoft.rest.ServiceFuture\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceFuture\"></xref> object"
|
|
type: "<xref href=\"com.microsoft.rest.ServiceFuture?alt=com.microsoft.rest.ServiceFuture&text=ServiceFuture\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.publishEventsWithServiceResponseAsync(java.lang.String,java.util.List<com.microsoft.azure.eventgrid.models.EventGridEvent>)"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.publishEventsWithServiceResponseAsync(String topicHostname, List<EventGridEvent> events)"
|
|
name: "publishEventsWithServiceResponseAsync(String topicHostname, List<EventGridEvent> events)"
|
|
nameWithType: "EventGridClient.publishEventsWithServiceResponseAsync(String topicHostname, List<EventGridEvent> events)"
|
|
summary: "Publishes a batch of events to an Azure Event Grid topic."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net"
|
|
name: "topicHostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An array of events to be published to Event Grid."
|
|
name: "events"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.eventgrid.models.EventGridEvent?alt=com.microsoft.azure.eventgrid.models.EventGridEvent&text=EventGridEvent\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public abstract Observable<ServiceResponse<Void>> publishEventsWithServiceResponseAsync(String topicHostname, List<EventGridEvent> events)"
|
|
desc: "Publishes a batch of events to an Azure Event Grid topic."
|
|
returns:
|
|
description: "the <xref uid=\"com.microsoft.rest.ServiceResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceResponse\"></xref> object if successful."
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.rest.ServiceResponse?alt=com.microsoft.rest.ServiceResponse&text=ServiceResponse\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.restClient()"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.restClient()"
|
|
name: "restClient()"
|
|
nameWithType: "EventGridClient.restClient()"
|
|
summary: "Gets the REST client."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract RestClient restClient()"
|
|
desc: "Gets the REST client."
|
|
returns:
|
|
description: "the <xref uid=\"com.microsoft.rest.RestClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RestClient\"></xref> object."
|
|
type: "<xref href=\"com.microsoft.rest.RestClient?alt=com.microsoft.rest.RestClient&text=RestClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.userAgent()"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.userAgent()"
|
|
name: "userAgent()"
|
|
nameWithType: "EventGridClient.userAgent()"
|
|
summary: "Gets the User-Agent header for the client."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String userAgent()"
|
|
desc: "Gets the User-Agent header for the client."
|
|
returns:
|
|
description: "the user agent string."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.withAcceptLanguage(java.lang.String)"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.withAcceptLanguage(String acceptLanguage)"
|
|
name: "withAcceptLanguage(String acceptLanguage)"
|
|
nameWithType: "EventGridClient.withAcceptLanguage(String acceptLanguage)"
|
|
summary: "Sets Gets or sets the preferred language for the response.."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the acceptLanguage value."
|
|
name: "acceptLanguage"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract EventGridClient withAcceptLanguage(String acceptLanguage)"
|
|
desc: "Sets Gets or sets the preferred language for the response.."
|
|
returns:
|
|
description: "the service client itself"
|
|
type: "<xref href=\"com.microsoft.azure.eventgrid.EventGridClient?alt=com.microsoft.azure.eventgrid.EventGridClient&text=EventGridClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.withGenerateClientRequestId(boolean)"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.withGenerateClientRequestId(boolean generateClientRequestId)"
|
|
name: "withGenerateClientRequestId(boolean generateClientRequestId)"
|
|
nameWithType: "EventGridClient.withGenerateClientRequestId(boolean generateClientRequestId)"
|
|
summary: "Sets When set to true a unique x-ms-client-request-id value is generated and included in each request."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the generateClientRequestId value."
|
|
name: "generateClientRequestId"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract EventGridClient withGenerateClientRequestId(boolean generateClientRequestId)"
|
|
desc: "Sets When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.."
|
|
returns:
|
|
description: "the service client itself"
|
|
type: "<xref href=\"com.microsoft.azure.eventgrid.EventGridClient?alt=com.microsoft.azure.eventgrid.EventGridClient&text=EventGridClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventgrid.EventGridClient.withLongRunningOperationRetryTimeout(int)"
|
|
fullName: "com.microsoft.azure.eventgrid.EventGridClient.withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)"
|
|
name: "withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)"
|
|
nameWithType: "EventGridClient.withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)"
|
|
summary: "Sets Gets or sets the retry timeout in seconds for Long Running Operations."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the longRunningOperationRetryTimeout value."
|
|
name: "longRunningOperationRetryTimeout"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract EventGridClient withLongRunningOperationRetryTimeout(int longRunningOperationRetryTimeout)"
|
|
desc: "Sets Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.."
|
|
returns:
|
|
description: "the service client itself"
|
|
type: "<xref href=\"com.microsoft.azure.eventgrid.EventGridClient?alt=com.microsoft.azure.eventgrid.EventGridClient&text=EventGridClient\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "interface"
|
|
desc: "The interface for EventGridClient class."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.eventgrid"
|
|
artifact: com.microsoft.azure:azure-eventgrid:1.3.0
|