247 строки
32 KiB
YAML
247 строки
32 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder"
|
|
name: "EventGridPublisherClientBuilder"
|
|
nameWithType: "EventGridPublisherClientBuilder"
|
|
summary: "A Builder class to create service clients that can publish events to Event<wbr>Grid."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **EventGridPublisherClientBuilder**</br> implements <xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.AzureKeyCredentialTrait?alt=com.azure.core.client.traits.AzureKeyCredentialTrait&text=AzureKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.AzureSasCredentialTrait?alt=com.azure.core.client.traits.AzureSasCredentialTrait&text=AzureSasCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.EventGridPublisherClientBuilder()"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.EventGridPublisherClientBuilder()"
|
|
name: "EventGridPublisherClientBuilder()"
|
|
nameWithType: "EventGridPublisherClientBuilder.EventGridPublisherClientBuilder()"
|
|
summary: "Construct a new instance with default building settings."
|
|
syntax: "public EventGridPublisherClientBuilder()"
|
|
desc: "Construct a new instance with default building settings. The endpoint and one credential method must be set in order for the client to be built."
|
|
methods:
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.addPolicy(HttpPipelinePolicy httpPipelinePolicy)"
|
|
name: "addPolicy(HttpPipelinePolicy httpPipelinePolicy)"
|
|
nameWithType: "EventGridPublisherClientBuilder.addPolicy(HttpPipelinePolicy httpPipelinePolicy)"
|
|
parameters:
|
|
- name: "httpPipelinePolicy"
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder addPolicy(HttpPipelinePolicy httpPipelinePolicy)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildCloudEventPublisherAsyncClient()"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildCloudEventPublisherAsyncClient()"
|
|
name: "buildCloudEventPublisherAsyncClient()"
|
|
nameWithType: "EventGridPublisherClientBuilder.buildCloudEventPublisherAsyncClient()"
|
|
summary: "Build a <xref uid=\"com.azure.core.models.CloudEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudEvent\"></xref> publisher client with asynchronous publishing methods and the current settings."
|
|
syntax: "public EventGridPublisherAsyncClient<CloudEvent> buildCloudEventPublisherAsyncClient()"
|
|
desc: "Build a <xref uid=\"com.azure.core.models.CloudEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudEvent\"></xref> publisher client with asynchronous publishing methods and the current settings. An endpoint must be set, and either a pipeline with correct authentication must be set, or a credential must be set in the form of an <xref uid=\"com.azure.core.credential.AzureSasCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureSasCredential\"></xref> or a <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> at the respective methods. All other settings have defaults and are optional."
|
|
returns:
|
|
description: "a publisher client with asynchronous publishing methods."
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherAsyncClient?alt=com.azure.messaging.eventgrid.EventGridPublisherAsyncClient&text=EventGridPublisherAsyncClient\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.models.CloudEvent?alt=com.azure.core.models.CloudEvent&text=CloudEvent\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildCloudEventPublisherClient()"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildCloudEventPublisherClient()"
|
|
name: "buildCloudEventPublisherClient()"
|
|
nameWithType: "EventGridPublisherClientBuilder.buildCloudEventPublisherClient()"
|
|
summary: "Build a <xref uid=\"com.azure.core.models.CloudEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudEvent\"></xref> publisher client with synchronous publishing methods and the current settings."
|
|
syntax: "public EventGridPublisherClient<CloudEvent> buildCloudEventPublisherClient()"
|
|
desc: "Build a <xref uid=\"com.azure.core.models.CloudEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudEvent\"></xref> publisher client with synchronous publishing methods and the current settings. Endpoint and a credential must be set (either keyCredential or sharedAccessSignatureCredential), all other settings have defaults and/or are optional."
|
|
returns:
|
|
description: "a publisher client with synchronous publishing methods."
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClient?alt=com.azure.messaging.eventgrid.EventGridPublisherClient&text=EventGridPublisherClient\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.models.CloudEvent?alt=com.azure.core.models.CloudEvent&text=CloudEvent\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildCustomEventPublisherAsyncClient()"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildCustomEventPublisherAsyncClient()"
|
|
name: "buildCustomEventPublisherAsyncClient()"
|
|
nameWithType: "EventGridPublisherClientBuilder.buildCustomEventPublisherAsyncClient()"
|
|
summary: "Build a custom event publisher client with asynchronous publishing methods and the current settings."
|
|
syntax: "public EventGridPublisherAsyncClient<BinaryData> buildCustomEventPublisherAsyncClient()"
|
|
desc: "Build a custom event publisher client with asynchronous publishing methods and the current settings. An endpoint must be set, and either a pipeline with correct authentication must be set, or a credential must be set in the form of an <xref uid=\"com.azure.core.credential.AzureSasCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureSasCredential\"></xref> or a <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> at the respective methods. All other settings have defaults and are optional."
|
|
returns:
|
|
description: "a publisher client with asynchronous publishing methods."
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherAsyncClient?alt=com.azure.messaging.eventgrid.EventGridPublisherAsyncClient&text=EventGridPublisherAsyncClient\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildCustomEventPublisherClient()"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildCustomEventPublisherClient()"
|
|
name: "buildCustomEventPublisherClient()"
|
|
nameWithType: "EventGridPublisherClientBuilder.buildCustomEventPublisherClient()"
|
|
summary: "Build a custom event publisher client with synchronous publishing methods and the current settings."
|
|
syntax: "public EventGridPublisherClient<BinaryData> buildCustomEventPublisherClient()"
|
|
desc: "Build a custom event publisher client with synchronous publishing methods and the current settings. Endpoint and a credential must be set (either keyCredential or sharedAccessSignatureCredential), all other settings have defaults and/or are optional."
|
|
returns:
|
|
description: "a publisher client with synchronous publishing methods."
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClient?alt=com.azure.messaging.eventgrid.EventGridPublisherClient&text=EventGridPublisherClient\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildEventGridEventPublisherAsyncClient()"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildEventGridEventPublisherAsyncClient()"
|
|
name: "buildEventGridEventPublisherAsyncClient()"
|
|
nameWithType: "EventGridPublisherClientBuilder.buildEventGridEventPublisherAsyncClient()"
|
|
summary: "Build an <xref uid=\"com.azure.messaging.eventgrid.EventGridEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventGridEvent\"></xref> publisher client with asynchronous publishing methods and the current settings."
|
|
syntax: "public EventGridPublisherAsyncClient<EventGridEvent> buildEventGridEventPublisherAsyncClient()"
|
|
desc: "Build an <xref uid=\"com.azure.messaging.eventgrid.EventGridEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventGridEvent\"></xref> publisher client with asynchronous publishing methods and the current settings. An endpoint must be set, and either a pipeline with correct authentication must be set, or a credential must be set in the form of an <xref uid=\"com.azure.core.credential.AzureSasCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureSasCredential\"></xref> or a <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> at the respective methods. All other settings have defaults and are optional."
|
|
returns:
|
|
description: "a publisher client with asynchronous publishing methods."
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherAsyncClient?alt=com.azure.messaging.eventgrid.EventGridPublisherAsyncClient&text=EventGridPublisherAsyncClient\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridEvent?alt=com.azure.messaging.eventgrid.EventGridEvent&text=EventGridEvent\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildEventGridEventPublisherClient()"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.buildEventGridEventPublisherClient()"
|
|
name: "buildEventGridEventPublisherClient()"
|
|
nameWithType: "EventGridPublisherClientBuilder.buildEventGridEventPublisherClient()"
|
|
summary: "Build an <xref uid=\"com.azure.messaging.eventgrid.EventGridEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventGridEvent\"></xref> publisher client with synchronous publishing methods and the current settings."
|
|
syntax: "public EventGridPublisherClient<EventGridEvent> buildEventGridEventPublisherClient()"
|
|
desc: "Build an <xref uid=\"com.azure.messaging.eventgrid.EventGridEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventGridEvent\"></xref> publisher client with synchronous publishing methods and the current settings. Endpoint and a credential must be set (either keyCredential or sharedAccessSignatureCredential), all other settings have defaults and/or are optional."
|
|
returns:
|
|
description: "a publisher client with synchronous publishing methods."
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClient?alt=com.azure.messaging.eventgrid.EventGridPublisherClient&text=EventGridPublisherClient\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridEvent?alt=com.azure.messaging.eventgrid.EventGridEvent&text=EventGridEvent\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "EventGridPublisherClientBuilder.clientOptions(ClientOptions clientOptions)"
|
|
parameters:
|
|
- name: "clientOptions"
|
|
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder clientOptions(ClientOptions clientOptions)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.configuration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.configuration(Configuration configuration)"
|
|
name: "configuration(Configuration configuration)"
|
|
nameWithType: "EventGridPublisherClientBuilder.configuration(Configuration configuration)"
|
|
parameters:
|
|
- name: "configuration"
|
|
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder configuration(Configuration configuration)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.credential(AzureKeyCredential credential)"
|
|
name: "credential(AzureKeyCredential credential)"
|
|
nameWithType: "EventGridPublisherClientBuilder.credential(AzureKeyCredential credential)"
|
|
parameters:
|
|
- name: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.AzureKeyCredential?alt=com.azure.core.credential.AzureKeyCredential&text=AzureKeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder credential(AzureKeyCredential credential)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.credential(com.azure.core.credential.AzureSasCredential)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.credential(AzureSasCredential credential)"
|
|
name: "credential(AzureSasCredential credential)"
|
|
nameWithType: "EventGridPublisherClientBuilder.credential(AzureSasCredential credential)"
|
|
parameters:
|
|
- name: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.AzureSasCredential?alt=com.azure.core.credential.AzureSasCredential&text=AzureSasCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder credential(AzureSasCredential credential)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.credential(TokenCredential credential)"
|
|
name: "credential(TokenCredential credential)"
|
|
nameWithType: "EventGridPublisherClientBuilder.credential(TokenCredential credential)"
|
|
parameters:
|
|
- name: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder credential(TokenCredential credential)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.endpoint(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.endpoint(String endpoint)"
|
|
name: "endpoint(String endpoint)"
|
|
nameWithType: "EventGridPublisherClientBuilder.endpoint(String endpoint)"
|
|
summary: "Set the domain or topic endpoint."
|
|
parameters:
|
|
- description: "the endpoint as a url."
|
|
name: "endpoint"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public EventGridPublisherClientBuilder endpoint(String endpoint)"
|
|
desc: "Set the domain or topic endpoint. This is the address to publish events to. It must be the full url of the endpoint instead of just the hostname."
|
|
returns:
|
|
description: "the builder itself."
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.httpClient(HttpClient httpClient)"
|
|
name: "httpClient(HttpClient httpClient)"
|
|
nameWithType: "EventGridPublisherClientBuilder.httpClient(HttpClient httpClient)"
|
|
parameters:
|
|
- name: "httpClient"
|
|
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder httpClient(HttpClient httpClient)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
|
name: "httpLogOptions(HttpLogOptions httpLogOptions)"
|
|
nameWithType: "EventGridPublisherClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
|
parameters:
|
|
- name: "httpLogOptions"
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
name: "pipeline(HttpPipeline httpPipeline)"
|
|
nameWithType: "EventGridPublisherClientBuilder.pipeline(HttpPipeline httpPipeline)"
|
|
parameters:
|
|
- name: "httpPipeline"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder pipeline(HttpPipeline httpPipeline)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
name: "retryOptions(RetryOptions retryOptions)"
|
|
nameWithType: "EventGridPublisherClientBuilder.retryOptions(RetryOptions retryOptions)"
|
|
parameters:
|
|
- name: "retryOptions"
|
|
type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder retryOptions(RetryOptions retryOptions)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
|
name: "retryPolicy(RetryPolicy retryPolicy)"
|
|
nameWithType: "EventGridPublisherClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
|
summary: "Add a custom retry policy to the pipeline."
|
|
parameters:
|
|
- description: "the retry policy to add."
|
|
name: "retryPolicy"
|
|
type: "<xref href=\"com.azure.core.http.policy.RetryPolicy?alt=com.azure.core.http.policy.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
|
desc: "Add a custom retry policy to the pipeline. The default is <xref uid=\"com.azure.core.http.policy.RetryPolicy.RetryPolicy*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy#RetryPolicy()\"></xref>. Setting this is mutually exclusive with using <xref uid=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
|
|
returns:
|
|
description: "the builder itself."
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.serviceVersion(com.azure.messaging.eventgrid.EventGridServiceVersion)"
|
|
fullName: "com.azure.messaging.eventgrid.EventGridPublisherClientBuilder.serviceVersion(EventGridServiceVersion serviceVersion)"
|
|
name: "serviceVersion(EventGridServiceVersion serviceVersion)"
|
|
nameWithType: "EventGridPublisherClientBuilder.serviceVersion(EventGridServiceVersion serviceVersion)"
|
|
summary: "Set the service version to use for requests to the event grid service."
|
|
parameters:
|
|
- description: "the service version to set. By default this will use the latest available version."
|
|
name: "serviceVersion"
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridServiceVersion?alt=com.azure.messaging.eventgrid.EventGridServiceVersion&text=EventGridServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public EventGridPublisherClientBuilder serviceVersion(EventGridServiceVersion serviceVersion)"
|
|
desc: "Set the service version to use for requests to the event grid service. See <xref uid=\"com.azure.messaging.eventgrid.EventGridServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventGridServiceVersion\"></xref> for more information about possible service versions."
|
|
returns:
|
|
description: "the builder itself"
|
|
type: "<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A Builder class to create service clients that can publish events to EventGrid. This builder will construct publishers for <xref uid=\"com.azure.core.models.CloudEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudEvent\"></xref>, <xref uid=\"com.azure.messaging.eventgrid.EventGridEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventGridEvent\"></xref>, and custom events. It will do for both sync and async clients.\n\n**Sample: Create a <xref uid=\"com.azure.messaging.eventgrid.EventGridEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventGridEvent\"></xref> asynchronous publisher client.**\n\n```java\n// Create a client to send events of EventGridEvent schema\n EventGridPublisherAsyncClient<EventGridEvent> eventGridEventPublisherClient = new EventGridPublisherClientBuilder()\n .endpoint(System.getenv(\"AZURE_EVENTGRID_EVENT_ENDPOINT\")) // make sure it accepts EventGridEvent\n .credential(new AzureKeyCredential(System.getenv(\"AZURE_EVENTGRID_EVENT_KEY\")))\n .buildEventGridEventPublisherAsyncClient();\n```\n\n**Sample: Create a <xref uid=\"com.azure.core.models.CloudEvent\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CloudEvent\"></xref> synchronous client**\n\n```java\n// Create a client to send events of CloudEvent schema (com.azure.core.models.CloudEvent)\n EventGridPublisherClient<CloudEvent> cloudEventPublisherClient = new EventGridPublisherClientBuilder()\n .endpoint(System.getenv(\"AZURE_EVENTGRID_CLOUDEVENT_ENDPOINT\")) // make sure it accepts CloudEvent\n .credential(new AzureKeyCredential(System.getenv(\"AZURE_EVENTGRID_CLOUDEVENT_KEY\")))\n .buildCloudEventPublisherClient();\n```\n\n**Sample: Create a custom event asynchronous client**\n\n```java\n// Create a client to send events of custom event\n EventGridPublisherAsyncClient<BinaryData> customEventPublisherClient = new EventGridPublisherClientBuilder()\n .endpoint(System.getenv(\"AZURE_CUSTOM_EVENT_ENDPOINT\")) // make sure it accepts custom events\n .credential(new AzureKeyCredential(System.getenv(\"AZURE_CUSTOM_EVENT_KEY\")))\n .buildCustomEventPublisherAsyncClient();\n```"
|
|
implements:
|
|
- "<xref href=\"com.azure.core.client.traits.AzureKeyCredentialTrait?alt=com.azure.core.client.traits.AzureKeyCredentialTrait&text=AzureKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.AzureSasCredentialTrait?alt=com.azure.core.client.traits.AzureSasCredentialTrait&text=AzureSasCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.messaging.eventgrid.EventGridPublisherClientBuilder?alt=com.azure.messaging.eventgrid.EventGridPublisherClientBuilder&text=EventGridPublisherClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.messaging.eventgrid"
|
|
artifact: com.azure:azure-messaging-eventgrid:4.24.0
|