Skip to content

Commit a19d128

Browse files
srnagarxseeseesee
authored andcommitted
README for samples in Event Hubs (#6710)
* README for samples in Event Hubs * Add impressions * Add missing readme sections * Update root readme with reference to sample readme
1 parent 4f993c9 commit a19d128

File tree

4 files changed

+91
-15
lines changed

4 files changed

+91
-15
lines changed

sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,7 @@ example, setting `AZURE_LOG_LEVEL=2` would show all informational, warning, and
128128
be found here: [log levels][source_loglevels].
129129

130130
## Next steps
131-
Get started by exploring the following samples:
132-
133-
1. [Blob Event Processor Store samples][sample_examples]
134-
1. [Event Hubs and Event Processor samples][sample_event_hubs]
131+
Get started by exploring the samples [here][samples_readme].
135132

136133
## Contributing
137134

@@ -144,6 +141,7 @@ Guidelines](./CONTRIBUTING.md) for more information.
144141
[java_8_sdk_javadocs]: https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html
145142
[maven]: https://maven.apache.org/
146143
[performance_tuning]: https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning
144+
[samples_readme]: ./src/samples/README.md
147145
[sample_container_client]: ./src/samples/java/com/azure/messaging/eventhubs/checkpointstore/blob/BlobCheckpointStoreSample.java
148146
[sample_event_hubs]: ./src/samples/java/com/azure/messaging/eventhubs
149147
[sample_event_processor]: ./src/samples/java/com/azure/messaging/eventhubs/checkpointstore/blob/EventProcessorBlobCheckpointStoreSample.java
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Azure Event Hubs Checkpoint Store client library for Java - Samples
2+
3+
Azure Event Hubs Checkpoint Store samples are a set of self-contained Java programs that demonstrate interacting
4+
with Azure Event Hubs Checkpoint Store using the client library.
5+
6+
## Key concepts
7+
Key concepts are explained in detail [here][sdk_readme_key_concepts].
8+
9+
## Getting started
10+
Please refer to the [Getting Started][sdk_readme_getting_started] section.
11+
12+
## Examples
13+
14+
- [Create an instance of Storage Container client][sample_container_client]
15+
- [Consume events from all Event Hub partitions][sample_event_processor]
16+
17+
## Troubleshooting
18+
See [Troubleshooting][sdk_readme_troubleshooting].
19+
20+
## Next steps
21+
See [Next steps][sdk_readme_next_steps].
22+
23+
## Contributing
24+
25+
If you would like to become an active contributor to this project please refer to our [Contribution
26+
Guidelines](../../CONTRIBUTING.md) for more information.
27+
28+
<!-- Links -->
29+
[sdk_readme_key_concepts]: ../../README.md#key-concepts
30+
[sdk_readme_getting_started]: ../../README.md#getting-started
31+
[sdk_readme_troubleshooting]: ../../README.md#troubleshooting
32+
[sdk_readme_next_steps]: ../../README.md#next-steps
33+
[sample_container_client]: ./java/com/azure/messaging/eventhubs/checkpointstore/blob/BlobCheckpointStoreSample.java
34+
[sample_event_processor]: ./java/com/azure/messaging/eventhubs/checkpointstore/blob/EventProcessorBlobCheckpointStoreSample.java
35+
36+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Feventhubs%2Fazure-messaging-eventhubs-checkpointstore-blob%2Fsrc%2Fsamples%2FREADME.png)

sdk/eventhubs/azure-messaging-eventhubs/README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -412,17 +412,8 @@ Exceptions][event_hubs_messaging_exceptions].
412412

413413
Beyond those discussed, the Azure Event Hubs client library offers support for many additional scenarios to help take
414414
advantage of the full feature set of the Azure Event Hubs service. In order to help explore some of the these scenarios,
415-
the following set of sample is available:
416-
417-
- [Inspect Event Hub and partition properties][sample_get_event_hubs_metadata]
418-
- [Publish events using Microsoft identity platform][sample_publish_identity]
419-
- [Publish events to a specific Event Hub partition with partition identifier][sample_publish_partitionId]
420-
- [Publish events to a specific Event Hub partition with partition key][sample_publish_partitionKey]
421-
- [Publish events to an Event Hub with a size-limited batch][sample_publish_size_limited]
422-
- [Publish events with custom metadata][sample_publish_custom_metadata]
423-
- [Consume events from an Event Hub partition][sample_consume_event]
424-
- [Consume events starting from an event sequence number][sample_consume_sequence_number]
425-
- [Consume events from all partitions using EventProcessorClient][sample_event_processor]
415+
the following set of sample is available [here][samples_readme].
416+
426417

427418
## Contributing
428419

@@ -446,6 +437,7 @@ Guidelines](./CONTRIBUTING.md) for more information.
446437
[oasis_amqp_v1]: http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-overview-v1.0-os.html
447438
[performance_tuning]: https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning
448439
[qpid_proton_j_apache]: http://qpid.apache.org/proton/
440+
[samples_readme]: ./src/samples/README.md
449441
[sample_examples]: ./src/samples/java/com/azure/messaging/eventhubs/
450442
[sample_consume_event]: ./src/samples/java/com/azure/messaging/eventhubs/ConsumeEvents.java
451443
[sample_consume_sequence_number]: ./src/samples/java/com/azure/messaging/eventhubs/ConsumeEventsFromKnownSequenceNumberPosition.java
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Azure Event Hubs client library for Java - Samples
2+
3+
Azure Event Hubs samples are a set of self-contained Java programs that demonstrate interacting with Azure Event Hubs
4+
using the client library. Each sample focuses on a specific scenario and can be executed independently.
5+
6+
## Key concepts
7+
Key concepts are explained in detail [here][sdk_readme_key_concepts].
8+
9+
## Getting started
10+
Please refer to the [Getting Started][sdk_readme_getting_started] section.
11+
12+
## Examples
13+
14+
- [Inspect Event Hub and partition properties][sample_get_event_hubs_metadata]
15+
- [Publish events using Microsoft identity platform][sample_publish_identity]
16+
- [Publish events to a specific Event Hub partition with partition identifier][sample_publish_partitionId]
17+
- [Publish events to a specific Event Hub partition with partition key][sample_publish_partitionKey]
18+
- [Publish events to an Event Hub with a size-limited batch][sample_publish_size_limited]
19+
- [Publish events with custom metadata][sample_publish_custom_metadata]
20+
- [Consume events from an Event Hub partition][sample_consume_event]
21+
- [Consume events starting from an event sequence number][sample_consume_sequence_number]
22+
- [Consume events from all partitions using EventProcessorClient][sample_event_processor]
23+
24+
## Troubleshooting
25+
See [Troubleshooting][sdk_readme_troubleshooting].
26+
27+
## Next steps
28+
See [Next steps][sdk_readme_next_steps].
29+
30+
## Contributing
31+
32+
If you would like to become an active contributor to this project please refer to our [Contribution
33+
Guidelines](../../CONTRIBUTING.md) for more information.
34+
35+
<!-- Links -->
36+
[sdk_readme_key_concepts]: ../../README.md#key-concepts
37+
[sdk_readme_getting_started]: ../../README.md#getting-started
38+
[sdk_readme_troubleshooting]: ../../README.md#troubleshooting
39+
[sdk_readme_next_steps]: ../../README.md#next-steps
40+
[sample_consume_event]: ./java/com/azure/messaging/eventhubs/ConsumeEvents.java
41+
[sample_consume_sequence_number]: ./java/com/azure/messaging/eventhubs/ConsumeEventsFromKnownSequenceNumberPosition.java
42+
[sample_event_processor]: ./java/com/azure/messaging/eventhubs/EventProcessorSample.java
43+
[sample_get_event_hubs_metadata]: ./java/com/azure/messaging/eventhubs/GetEventHubMetadata.java
44+
[sample_publish_custom_metadata]: ./java/com/azure/messaging/eventhubs/PublishEventsWithCustomMetadata.java
45+
[sample_publish_identity]: ./java/com/azure/messaging/eventhubs/PublishEventsWithAzureIdentity.java
46+
[sample_publish_partitionId]: ./java/com/azure/messaging/eventhubs/PublishEventsToSpecificPartition.java
47+
[sample_publish_partitionKey]: ./java/com/azure/messaging/eventhubs/PublishEventsWithPartitionKey.java
48+
[sample_publish_size_limited]: ./java/com/azure/messaging/eventhubs/PublishEventsWithSizeLimitedBatches.java
49+
50+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Feventhubs%2Fazure-messaging-eventhubs%2Fsrc%2Fsamples%2README.png)

0 commit comments

Comments
 (0)