Skip to content

Conversation

@yiliuTo
Copy link
Member

@yiliuTo yiliuTo commented Dec 10, 2021

This pr is aimed to

  • improve java doc quality for public APIs of spring-azure-messaging-* libraries.
  • add missing java doc according to API-review results.

Involved libraries and the associated API-review results are as below:

  1. spring-azure-messaging: https://apiview.dev/Assemblies/Review/90e73b76bcf3478c82356d99d8b2089b
  2. spring-azure-messaging-eventhubs: https://apiview.dev/Assemblies/Review/58995c5facde49aa8898510ae955d5b6
  3. spring-azure-messaging-servicebus: https://apiview.dev/Assemblies/Review/72aca2ba5bd7413aabc8cbe99e06acf4
  4. spring-azure-messaging-storage-queue: https://apiview.dev/Assemblies/Review/fba59870bb51473db28b423394a1a75a

@yiliuTo yiliuTo added Client This issue points to a problem in the data-plane of the library. azure-spring All azure-spring related issues labels Dec 10, 2021
@yiliuTo yiliuTo added this to the Spring Cloud Azure 4.0 GA milestone Dec 10, 2021
@yiliuTo yiliuTo mentioned this pull request Dec 10, 2021
3 tasks
Copy link
Member

@saragluna saragluna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall it looks good to me. It still needs some minor changes.


/**
*
* A template for executing sending operations asynchronously to Event Hub.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Event Hubs

/**
* Construct a factory with the provided {@link CheckpointStore} and processor {@link PropertiesSupplier}.
* @param checkpointStore the checkpoint store.
* @param supplier the {@link PropertiesSupplier} to supply {@link ProcessorProperties} for each event hub entity.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

event hub

* Construct a factory with the provided {@link CheckpointStore}, namespace level properties and processor {@link PropertiesSupplier}.
* @param checkpointStore the checkpoint store.
* @param namespaceProperties the namespace properties.
* @param supplier the {@link PropertiesSupplier} to supply {@link ProcessorProperties} for each event hub entity.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

event hub

import java.util.concurrent.ConcurrentHashMap;

/**
* The {@link EventHubsProducerFactory} implementation to produce new {@link EventHubProducerAsyncClient} instances
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should mention it here that this implementation is a cached implementation.

/**
* Construct a factory with the provided namespace level configuration and producer {@link PropertiesSupplier}.
* @param namespaceProperties the namespace properties.
* @param supplier the {@link PropertiesSupplier} to supply {@link ProducerProperties} for each event hub entity.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

event hub.

Comment on lines 14 to 15
* Create {@link EventHubProducerAsyncClient} to send events to the Event Hub destination.
* @param eventHub the Event Hub destination
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

event hub


/**
* Set the track last enqueued event properties.
* @param trackLastEnqueuedEventProperties the track last enqueued event properties.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whether to track the last enqueued event properties?

@yiliuTo yiliuTo merged commit bd6970d into Azure:feature/azure-spring-cloud-4.0 Dec 14, 2021
azure-sdk pushed a commit to azure-sdk/azure-sdk-for-java that referenced this pull request Nov 8, 2023
Release network microsoft.network official 2023 06 01 (Azure#26218)

* Adds base for updating Microsoft.Network from version stable/2023-05-01 to version 2023-06-01

* Updates readme

* Updates API version in new specs and examples

* Add missing DeleteBastionShareableLinkByToken API back to swagger (Azure#25599)

* add DeleteBastionShareableLinkByToken endpoint
* fix location link format

* Adding Developer Sku (Azure#25887)

* Firewall Policy - IDPS profiles (Azure#25666)

* add profile to put example

* fixed RuleCollectionGroupWithHttpHeadersToInsert example

* add profile to Policy model

* description change

* indentation

* ListIdpsSignatures description change

* direction description+enum fix

* fix FirewallPolicyIDPSSignatureSeverity description

* hostnames for l4 listeners (Azure#25982)

* added ergwscale support (Azure#25969)

* Fixed examples for gateway load balancer (Azure#26058)

* Add support for JSChallenge action in Application Gateway Web application Firewall (Azure#26149)

* Add support for JSChallenge action

Add support for JSChallenge action in the list of supported actions for Custom rules and Managed rules

* Update WafPolicyGet.json

* Update WafPolicyCreateOrUpdate.json

* DDoS - Fixing Swagger Validation Issues on DDoSCustomPolicy (Azure#26248)

* fixes

* making changes in new api version

---------

Co-authored-by: Manas Chakka <manaschakka@microsoft.com>

* [NVA] Internet Ingress Parameters (Azure#26262)

* [NVA] Internet Ingress Parameters

* LintDiff Fix

* Minor Fix

* Added description for each of the enums for ApplicationGatewayProtocol (Azure#26437)

* Added description for each of the enums for ApplicationGatewayProtocol

* Spacing for prettier checks

* Remove routingConfigNfv (Azure#25962)

* remove routingConfigNfv

* remove api from older versions

* remove PUT nvaconnection from older versions

* apply prettier check

* add suppression for modelValidation

* remove suppression due to approval

* Fix lint errors & add supressions (Azure#26494)

* fix lint error

* add supression for ResourceNameRestriction & LroErrorContent

* fix example accordingly

---------

Co-authored-by: htippanaboya <102244326+htippanaboya@users.noreply.github.com>
Co-authored-by: Sijie Lin <97983749+msftsijielin@users.noreply.github.com>
Co-authored-by: anvrao1 <109107918+anvrao1@users.noreply.github.com>
Co-authored-by: NiviShenker <99583088+NiviShenker@users.noreply.github.com>
Co-authored-by: gdhillon24 <105729965+gdhillon24@users.noreply.github.com>
Co-authored-by: aneeshakella-microsoft <109654329+aneeshakella-microsoft@users.noreply.github.com>
Co-authored-by: irrogozh <irrogozh@microsoft.com>
Co-authored-by: ssevugan21 <122578291+ssevugan21@users.noreply.github.com>
Co-authored-by: Manas Chakka <mchakka@gmail.com>
Co-authored-by: Manas Chakka <manaschakka@microsoft.com>
Co-authored-by: JainRah <108508612+JainRah@users.noreply.github.com>
Co-authored-by: rutuja-s <42910715+rutuja-s@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

azure-spring All azure-spring related issues Client This issue points to a problem in the data-plane of the library.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants