diff --git a/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/README.md b/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/README.md index ee1050e85bbd..6035fe08f718 100644 --- a/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/README.md +++ b/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/README.md @@ -128,10 +128,7 @@ example, setting `AZURE_LOG_LEVEL=2` would show all informational, warning, and be found here: [log levels][source_loglevels]. ## Next steps -Get started by exploring the following samples: - -1. [Blob Event Processor Store samples][sample_examples] -1. [Event Hubs and Event Processor samples][sample_event_hubs] +Get started by exploring the samples [here][samples_readme]. ## Contributing @@ -144,6 +141,7 @@ Guidelines](./CONTRIBUTING.md) for more information. [java_8_sdk_javadocs]: https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html [maven]: https://maven.apache.org/ [performance_tuning]: https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning +[samples_readme]: ./src/samples/README.md [sample_container_client]: ./src/samples/java/com/azure/messaging/eventhubs/checkpointstore/blob/BlobCheckpointStoreSample.java [sample_event_hubs]: ./src/samples/java/com/azure/messaging/eventhubs [sample_event_processor]: ./src/samples/java/com/azure/messaging/eventhubs/checkpointstore/blob/EventProcessorBlobCheckpointStoreSample.java diff --git a/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/src/samples/README.md b/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/src/samples/README.md new file mode 100644 index 000000000000..ffcc5d928853 --- /dev/null +++ b/sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/src/samples/README.md @@ -0,0 +1,36 @@ +# Azure Event Hubs Checkpoint Store client library for Java - Samples + +Azure Event Hubs Checkpoint Store samples are a set of self-contained Java programs that demonstrate interacting +with Azure Event Hubs Checkpoint Store using the client library. + +## Key concepts +Key concepts are explained in detail [here][sdk_readme_key_concepts]. + +## Getting started +Please refer to the [Getting Started][sdk_readme_getting_started] section. + +## Examples + +- [Create an instance of Storage Container client][sample_container_client] +- [Consume events from all Event Hub partitions][sample_event_processor] + +## Troubleshooting +See [Troubleshooting][sdk_readme_troubleshooting]. + +## Next steps +See [Next steps][sdk_readme_next_steps]. + +## Contributing + +If you would like to become an active contributor to this project please refer to our [Contribution +Guidelines](../../CONTRIBUTING.md) for more information. + + +[sdk_readme_key_concepts]: ../../README.md#key-concepts +[sdk_readme_getting_started]: ../../README.md#getting-started +[sdk_readme_troubleshooting]: ../../README.md#troubleshooting +[sdk_readme_next_steps]: ../../README.md#next-steps +[sample_container_client]: ./java/com/azure/messaging/eventhubs/checkpointstore/blob/BlobCheckpointStoreSample.java +[sample_event_processor]: ./java/com/azure/messaging/eventhubs/checkpointstore/blob/EventProcessorBlobCheckpointStoreSample.java + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Feventhubs%2Fazure-messaging-eventhubs-checkpointstore-blob%2Fsrc%2Fsamples%2FREADME.png) diff --git a/sdk/eventhubs/azure-messaging-eventhubs/README.md b/sdk/eventhubs/azure-messaging-eventhubs/README.md index bd1efca45f11..2e2d9783ed75 100644 --- a/sdk/eventhubs/azure-messaging-eventhubs/README.md +++ b/sdk/eventhubs/azure-messaging-eventhubs/README.md @@ -412,17 +412,8 @@ Exceptions][event_hubs_messaging_exceptions]. Beyond those discussed, the Azure Event Hubs client library offers support for many additional scenarios to help take advantage of the full feature set of the Azure Event Hubs service. In order to help explore some of the these scenarios, -the following set of sample is available: - -- [Inspect Event Hub and partition properties][sample_get_event_hubs_metadata] -- [Publish events using Microsoft identity platform][sample_publish_identity] -- [Publish events to a specific Event Hub partition with partition identifier][sample_publish_partitionId] -- [Publish events to a specific Event Hub partition with partition key][sample_publish_partitionKey] -- [Publish events to an Event Hub with a size-limited batch][sample_publish_size_limited] -- [Publish events with custom metadata][sample_publish_custom_metadata] -- [Consume events from an Event Hub partition][sample_consume_event] -- [Consume events starting from an event sequence number][sample_consume_sequence_number] -- [Consume events from all partitions using EventProcessorClient][sample_event_processor] +the following set of sample is available [here][samples_readme]. + ## Contributing @@ -446,6 +437,7 @@ Guidelines](./CONTRIBUTING.md) for more information. [oasis_amqp_v1]: http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-overview-v1.0-os.html [performance_tuning]: https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning [qpid_proton_j_apache]: http://qpid.apache.org/proton/ +[samples_readme]: ./src/samples/README.md [sample_examples]: ./src/samples/java/com/azure/messaging/eventhubs/ [sample_consume_event]: ./src/samples/java/com/azure/messaging/eventhubs/ConsumeEvents.java [sample_consume_sequence_number]: ./src/samples/java/com/azure/messaging/eventhubs/ConsumeEventsFromKnownSequenceNumberPosition.java diff --git a/sdk/eventhubs/azure-messaging-eventhubs/src/samples/README.md b/sdk/eventhubs/azure-messaging-eventhubs/src/samples/README.md new file mode 100644 index 000000000000..e4149dc57766 --- /dev/null +++ b/sdk/eventhubs/azure-messaging-eventhubs/src/samples/README.md @@ -0,0 +1,50 @@ +# Azure Event Hubs client library for Java - Samples + +Azure Event Hubs samples are a set of self-contained Java programs that demonstrate interacting with Azure Event Hubs +using the client library. Each sample focuses on a specific scenario and can be executed independently. + +## Key concepts +Key concepts are explained in detail [here][sdk_readme_key_concepts]. + +## Getting started +Please refer to the [Getting Started][sdk_readme_getting_started] section. + +## Examples + +- [Inspect Event Hub and partition properties][sample_get_event_hubs_metadata] +- [Publish events using Microsoft identity platform][sample_publish_identity] +- [Publish events to a specific Event Hub partition with partition identifier][sample_publish_partitionId] +- [Publish events to a specific Event Hub partition with partition key][sample_publish_partitionKey] +- [Publish events to an Event Hub with a size-limited batch][sample_publish_size_limited] +- [Publish events with custom metadata][sample_publish_custom_metadata] +- [Consume events from an Event Hub partition][sample_consume_event] +- [Consume events starting from an event sequence number][sample_consume_sequence_number] +- [Consume events from all partitions using EventProcessorClient][sample_event_processor] + +## Troubleshooting +See [Troubleshooting][sdk_readme_troubleshooting]. + +## Next steps +See [Next steps][sdk_readme_next_steps]. + +## Contributing + +If you would like to become an active contributor to this project please refer to our [Contribution +Guidelines](../../CONTRIBUTING.md) for more information. + + +[sdk_readme_key_concepts]: ../../README.md#key-concepts +[sdk_readme_getting_started]: ../../README.md#getting-started +[sdk_readme_troubleshooting]: ../../README.md#troubleshooting +[sdk_readme_next_steps]: ../../README.md#next-steps +[sample_consume_event]: ./java/com/azure/messaging/eventhubs/ConsumeEvents.java +[sample_consume_sequence_number]: ./java/com/azure/messaging/eventhubs/ConsumeEventsFromKnownSequenceNumberPosition.java +[sample_event_processor]: ./java/com/azure/messaging/eventhubs/EventProcessorSample.java +[sample_get_event_hubs_metadata]: ./java/com/azure/messaging/eventhubs/GetEventHubMetadata.java +[sample_publish_custom_metadata]: ./java/com/azure/messaging/eventhubs/PublishEventsWithCustomMetadata.java +[sample_publish_identity]: ./java/com/azure/messaging/eventhubs/PublishEventsWithAzureIdentity.java +[sample_publish_partitionId]: ./java/com/azure/messaging/eventhubs/PublishEventsToSpecificPartition.java +[sample_publish_partitionKey]: ./java/com/azure/messaging/eventhubs/PublishEventsWithPartitionKey.java +[sample_publish_size_limited]: ./java/com/azure/messaging/eventhubs/PublishEventsWithSizeLimitedBatches.java + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Feventhubs%2Fazure-messaging-eventhubs%2Fsrc%2Fsamples%2README.png)