diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 612d96e56fb3..b32b12676b40 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ Thank you for your interest in contributing to Azure SDK for Java. - After cloning the repo, copy the [pre-commit hooks file](https://github.com/Azure/azure-sdk-for-java/tree/main/eng/scripts/pre-commit) (located at `eng/scripts/pre-commit`) to your local `.git/hooks/` directory. This will run some validations before your changes are committed. -- Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#testing-for-spotbugs-and-checkstyle-issues) to learn about how Azure SDK for java generates CheckStyle, SpotBugs, Jacoco, and JavaDoc reports. +- Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#testing-for-spotbugs-and-checkstyle-issues) to learn about how Azure SDK for Java generates CheckStyle, SpotBugs, Jacoco, and JavaDoc reports. - There are two Maven projects in the repo. Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#pomclientxml-vs-pomdataxml) to learn about project structure for each. diff --git a/SUPPORT.md b/SUPPORT.md index ffc0c3c67db9..73a0de6b9665 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -25,7 +25,7 @@ To ensure the relevance and manageability of our issue queue, we have an automat - Ask a question at [Microsoft Tech Community](https://techcommunity.microsoft.com/t5/azure/ct-p/Azure) ### Security bugs -Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center(secure@microsoft.com). +Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (secure@microsoft.com). You should receive a response within 24 hours. Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue?rtc=1) diff --git a/common/perf-test-core/src/main/java/com/azure/perf/test/core/ApiPerfTestBase.java b/common/perf-test-core/src/main/java/com/azure/perf/test/core/ApiPerfTestBase.java index 9a8da38fba0a..863973f47c94 100644 --- a/common/perf-test-core/src/main/java/com/azure/perf/test/core/ApiPerfTestBase.java +++ b/common/perf-test-core/src/main/java/com/azure/perf/test/core/ApiPerfTestBase.java @@ -65,7 +65,7 @@ public abstract class ApiPerfTestBase extend * Creates an instance of the Http Based Performance test. * * @param options the performance test options to use while running the test. - * @throws IllegalStateException if an errors is encountered with building ssl context. + * @throws IllegalStateException if an error is encountered with building ssl context. */ public ApiPerfTestBase(TOptions options) { super(options); @@ -462,7 +462,7 @@ private Mono startPlaybackAsync() { /** * Records responses and starts tests in playback mode. * - * @return + * @return An empty {@link Mono}. */ @Override Mono postSetupAsync() { diff --git a/common/perf-test-core/src/main/java/com/azure/perf/test/core/MockBatchReceiverTest.java b/common/perf-test-core/src/main/java/com/azure/perf/test/core/MockBatchReceiverTest.java index c32e99b3c11d..0a0efa0cc69f 100644 --- a/common/perf-test-core/src/main/java/com/azure/perf/test/core/MockBatchReceiverTest.java +++ b/common/perf-test-core/src/main/java/com/azure/perf/test/core/MockBatchReceiverTest.java @@ -61,7 +61,7 @@ public int getMaxMessageCount() { /** * Get the Min Message count. - * @return the Min + * @return the minimum message count */ public int getMinMessageCount() { return minMessageCount; diff --git a/common/perf-test-core/src/main/java/com/azure/perf/test/core/PerfStressProgram.java b/common/perf-test-core/src/main/java/com/azure/perf/test/core/PerfStressProgram.java index 66eae27f7f3e..eecffca8aea8 100644 --- a/common/perf-test-core/src/main/java/com/azure/perf/test/core/PerfStressProgram.java +++ b/common/perf-test-core/src/main/java/com/azure/perf/test/core/PerfStressProgram.java @@ -58,7 +58,7 @@ private static double getOperationsPerSecond(PerfTestBase[] tests) { * Runs the performance tests passed to be executed. * * @param classes the performance test classes to execute. - * @param args the command line arguments ro run performance tests with. + * @param args the command line arguments to run performance tests with. * @throws RuntimeException if the execution fails. */ public static void run(Class[] classes, String[] args) { @@ -111,7 +111,7 @@ private static String getCommandName(String testName) { * Run the performance test passed to be executed. * * @param testClass the performance test class to execute. - * @param options the configuration ro run performance test with. + * @param options the configuration to run performance test with. * @throws RuntimeException if the execution fails. */ public static void run(Class testClass, PerfStressOptions options) { @@ -257,12 +257,12 @@ private static void writeKeyValue(String key, Object value, StringBuilder sb, At * Runs the performance tests passed to be executed. * * @param tests the performance tests to be executed. - * @param sync indicate if synchronous test should be run. - * @param completableFuture indicate if completable future test should be run. - * @param executorService indicate if executor service test should be run. - * @param virtualThread indicate if virtual thread test should be run. + * @param sync indicates if synchronous test should be run. + * @param completableFuture indicates if completable future test should be run. + * @param executorService indicates if executor service test should be run. + * @param virtualThread indicates if virtual thread test should be run. * @param parallel the number of parallel threads to run the performance test on. - * @param durationSeconds the duration for which performance test should be run on. + * @param durationSeconds the duration for which performance test should be run for. * @param title the title of the performance tests. * * @throws RuntimeException if the execution fails. @@ -307,7 +307,7 @@ public static void runTests(PerfTestBase[] tests, boolean sync, boolean compl = CompletableFuture.allOf(futures.toArray(new CompletableFuture[0])); allFutures.get(); // Wait for all futures to complete } else if (executorService) { - // when updated to concurrentTaskLimit, the performance drops? + // When updated to concurrentTaskLimit, the performance drops. ExecutorService executor = Executors.newFixedThreadPool(tests.length); try { for (PerfTestBase test : tests) { @@ -358,7 +358,7 @@ public static void runTests(PerfTestBase[] tests, boolean sync, boolean compl long totalOperations = getCompletedOperations(tests); if (totalOperations == 0) { - throw new IllegalStateException("Zero operations has been completed"); + throw new IllegalStateException("Zero operations have been completed"); } double operationsPerSecond = getOperationsPerSecond(tests); double secondsPerOperation = 1 / operationsPerSecond; diff --git a/common/perf-test-core/src/main/java/com/azure/perf/test/core/TestDataCreationHelper.java b/common/perf-test-core/src/main/java/com/azure/perf/test/core/TestDataCreationHelper.java index b06c8e389f44..a5c2b1c3cf92 100644 --- a/common/perf-test-core/src/main/java/com/azure/perf/test/core/TestDataCreationHelper.java +++ b/common/perf-test-core/src/main/java/com/azure/perf/test/core/TestDataCreationHelper.java @@ -119,7 +119,7 @@ public static long copyStream(InputStream inputStream, OutputStream outputStream } /** - * Generate random string of given {@code targetLength length}. The string will only have lower case alphabets. + * Generate random string of given {@code targetLength}. The string will only have lower case alphabets. * * @param targetLength of the string to be generated. * @return the generated string. @@ -139,7 +139,7 @@ public static String generateRandomString(int targetLength) { /** * Writes contents of the specified size to the specified file path. * - * @param filePath the path of the file to write to contents to + * @param filePath the path of the file to write contents to * @param size the size of the contents to write to the file. * @param bufferSize the size of the buffer to use to write to the file. * @throws IOException when an error occurs when writing to the file. diff --git a/common/perf-test-core/src/main/java/com/azure/perf/test/core/TestProxyPolicy.java b/common/perf-test-core/src/main/java/com/azure/perf/test/core/TestProxyPolicy.java index e9045400845a..aad5c63a3a74 100644 --- a/common/perf-test-core/src/main/java/com/azure/perf/test/core/TestProxyPolicy.java +++ b/common/perf-test-core/src/main/java/com/azure/perf/test/core/TestProxyPolicy.java @@ -102,7 +102,7 @@ private void redirectToTestProxy(HttpRequest request) { @Override public HttpPipelinePosition getPipelinePosition() { - // The policy should be ran per retry in case calls are made to a secondary, fail-over host. + // The policy should be run per retry in case calls are made to a secondary, fail-over host. return HttpPipelinePosition.PER_RETRY; } } diff --git a/eng/automation/changelog/src/main/java/com/azure/resourcemanager/tools/changelog/changelog/DefinitionStageChangeLog.java b/eng/automation/changelog/src/main/java/com/azure/resourcemanager/tools/changelog/changelog/DefinitionStageChangeLog.java index b9145f00ef7d..ebccf055ddc7 100644 --- a/eng/automation/changelog/src/main/java/com/azure/resourcemanager/tools/changelog/changelog/DefinitionStageChangeLog.java +++ b/eng/automation/changelog/src/main/java/com/azure/resourcemanager/tools/changelog/changelog/DefinitionStageChangeLog.java @@ -40,7 +40,7 @@ public class DefinitionStageChangeLog extends ChangeLog { * * @param blankStage The start point for BFS, which is the first stage. * @param stageToMethods contains all stages. Map from Stage name to all methods it has. - * @param getReturnType The function to map a JApiMethod to its according return type, which is the next stage name. + * @param getReturnType The function to map a JApiMethod to its corresponding return type, which is the next stage name. * @param resultForMethodsByStageIndex The result contains list of methods. The index represents which stage the method locates. */ private void calcMethodStages(AllMethods blankStage, Map stageToMethods, Function getReturnType, List> resultForMethodsByStageIndex) { diff --git a/eng/bomgenerator/readme.md b/eng/bomgenerator/readme.md index 9720a28216e0..0f565a95de41 100644 --- a/eng/bomgenerator/readme.md +++ b/eng/bomgenerator/readme.md @@ -9,12 +9,12 @@ Arguments to run the tool in this mode. 2. The BOM file which is the initial POM file. 3. InputDependencies file to override the inputs from the version_client.txt. This is an optional file. - -outputDir= + -outputDir= This generates the following files in the location. 1. Report log. 2. Newly created BOM file -2. Analyze mode - When run in this mode the tool validates the BOM. +2. Analyze mode - When run in this mode the tool validates the BOM. Arguments to run the tool in this mode. - -mode=analyze -inputDir= + -mode=analyze -inputDir= This location includes the pom file for the BOM or any library. diff --git a/eng/common/TestResources/README.md b/eng/common/TestResources/README.md index 8b801963a502..140ca90c7857 100644 --- a/eng/common/TestResources/README.md +++ b/eng/common/TestResources/README.md @@ -5,7 +5,7 @@ in Azure. Service directories that include a `test-resources.json` or `test-reso file require running [New-TestResources.ps1][] to create these resources and output environment variables you must set. -The following scripts can be used both in on your desktop for developer +The following scripts can be used both on your desktop for developer scenarios as well as on hosted agents for continuous integration testing. * [New-TestResources.ps1][] - Creates new test resources for a given service. diff --git a/eng/containers/README.md b/eng/containers/README.md index ba92e75d43bc..c8748f255d56 100644 --- a/eng/containers/README.md +++ b/eng/containers/README.md @@ -10,7 +10,7 @@ This folder contains dockerfiles for private container images used in Azure SDKs * `docker build . -t {registry}/java-tools/mvn:{new tag} -f jdk-mariner-mvn-dockerfile --build-arg MAVEN_VERSION={new version}` * Supported parameters: * `OPEN_JDK_MARINER_TAG`: one of the [JDK Mariner image tags](https://learn.microsoft.com/java/openjdk/containers#linux-based-images) - * `MAVEN_VERSION`: specifies verssion to download Maven from `https://apache.osuosl.org/maven/maven-3/${MAVEN_VERSION}/binaries/apache-maven-${MAVEN_VERSION}-bin.tar.gz` + * `MAVEN_VERSION`: specifies version to download Maven from `https://apache.osuosl.org/maven/maven-3/${MAVEN_VERSION}/binaries/apache-maven-${MAVEN_VERSION}-bin.tar.gz` * `MAVEN_URL`: override full URL to download `maven*.tar.gz` from. * `{new tag}` should contain JDK and maven versions. Follow the `jdk11-mvn3.9.5` naming pattern. diff --git a/samples/azure-samples-graalvm-spring-storageexplorer/src/main/java/com/azure/samples/graalvm/spring/storageexplorer/storage/StorageService.java b/samples/azure-samples-graalvm-spring-storageexplorer/src/main/java/com/azure/samples/graalvm/spring/storageexplorer/storage/StorageService.java index ca8d813a753d..ce1df4143a30 100644 --- a/samples/azure-samples-graalvm-spring-storageexplorer/src/main/java/com/azure/samples/graalvm/spring/storageexplorer/storage/StorageService.java +++ b/samples/azure-samples-graalvm-spring-storageexplorer/src/main/java/com/azure/samples/graalvm/spring/storageexplorer/storage/StorageService.java @@ -11,7 +11,7 @@ public interface StorageService { /** - * This method is called once when the web app starts to allow for initialisation of resources. + * This method is called once when the web app starts to allow for initialization of resources. */ void init(); @@ -27,7 +27,7 @@ public interface StorageService { /** * This method returns a stream of all files stored in the storage service. * - * @return + * @return A stream of all files stored in the storage service. */ Stream listAllFiles(); diff --git a/sdk/appconfiguration/azure-data-appconfiguration/TROUBLESHOOTING.md b/sdk/appconfiguration/azure-data-appconfiguration/TROUBLESHOOTING.md index e17fc59c2e60..4be279911b98 100644 --- a/sdk/appconfiguration/azure-data-appconfiguration/TROUBLESHOOTING.md +++ b/sdk/appconfiguration/azure-data-appconfiguration/TROUBLESHOOTING.md @@ -1,8 +1,8 @@ # Troubleshooting App Configuration issues -This troubleshooting guide covers failure investigation techniques, common errors for the credential types in the Azure -App Configuration Java client library, and mitigation steps to resolve these errors. The frequently asked question can -be found in [FAQ][faq] and common best practice sample can be found in [Best Practice Samples][best_practice_samples]. +This troubleshooting guide covers failure investigation techniques, common errors for the credential types in the Azure +App Configuration Java client library, and mitigation steps to resolve these errors. Frequently asked questions can +be found in [FAQ][faq] and common best practice samples can be found in [Best Practice Samples][best_practice_samples]. ## Table of Contents diff --git a/sdk/billing/azure-resourcemanager-billing/src/main/java/com/azure/resourcemanager/billing/models/BillingPropertyProperties.java b/sdk/billing/azure-resourcemanager-billing/src/main/java/com/azure/resourcemanager/billing/models/BillingPropertyProperties.java index 1c8e6e567cd7..e08f0b883e61 100644 --- a/sdk/billing/azure-resourcemanager-billing/src/main/java/com/azure/resourcemanager/billing/models/BillingPropertyProperties.java +++ b/sdk/billing/azure-resourcemanager-billing/src/main/java/com/azure/resourcemanager/billing/models/BillingPropertyProperties.java @@ -156,7 +156,7 @@ public final class BillingPropertyProperties implements JsonSerializable billingProfileSpendingLimitDetails() { @@ -355,7 +355,7 @@ public List billingProfileSpendingLimitDetails() { /** * Get the billingProfileStatus property: The status of the billing profile. - * + * * @return the billingProfileStatus value. */ public BillingProfileStatus billingProfileStatus() { @@ -364,7 +364,7 @@ public BillingProfileStatus billingProfileStatus() { /** * Get the billingProfileStatusReasonCode property: Reason for the specified billing profile status. - * + * * @return the billingProfileStatusReasonCode value. */ public BillingProfileStatusReasonCode billingProfileStatusReasonCode() { @@ -374,7 +374,7 @@ public BillingProfileStatusReasonCode billingProfileStatusReasonCode() { /** * Get the billingProfilePaymentMethodFamily property: The payment method family of the primary payment method for * the billing profile. - * + * * @return the billingProfilePaymentMethodFamily value. */ public PaymentMethodFamily billingProfilePaymentMethodFamily() { @@ -384,7 +384,7 @@ public PaymentMethodFamily billingProfilePaymentMethodFamily() { /** * Get the billingProfilePaymentMethodType property: The payment method type of the primary payment method for the * billing profile. - * + * * @return the billingProfilePaymentMethodType value. */ public String billingProfilePaymentMethodType() { @@ -393,7 +393,7 @@ public String billingProfilePaymentMethodType() { /** * Get the billingTenantId property: The Azure AD tenant ID of the billing account for the subscription. - * + * * @return the billingTenantId value. */ public String billingTenantId() { @@ -403,7 +403,7 @@ public String billingTenantId() { /** * Get the costCenter property: The cost center applied to the subscription. Available for agreement type Microsoft * Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch. - * + * * @return the costCenter value. */ public String costCenter() { @@ -413,7 +413,7 @@ public String costCenter() { /** * Set the costCenter property: The cost center applied to the subscription. Available for agreement type Microsoft * Customer Agreement and Microsoft Partner Agreement. This property can be updated via patch. - * + * * @param costCenter the costCenter value to set. * @return the BillingPropertyProperties object itself. */ @@ -424,7 +424,7 @@ public BillingPropertyProperties withCostCenter(String costCenter) { /** * Get the customerDisplayName property: The name of the customer. - * + * * @return the customerDisplayName value. */ public String customerDisplayName() { @@ -433,7 +433,7 @@ public String customerDisplayName() { /** * Get the customerId property: The fully qualified ID that uniquely identifies a customer. - * + * * @return the customerId value. */ public String customerId() { @@ -443,7 +443,7 @@ public String customerId() { /** * Get the customerStatus property: Identifies the status of an customer. This is an upcoming property that will be * populated in the future. - * + * * @return the customerStatus value. */ public CustomerStatus customerStatus() { @@ -452,7 +452,7 @@ public CustomerStatus customerStatus() { /** * Get the invoiceSectionDisplayName property: The name of the invoice section. - * + * * @return the invoiceSectionDisplayName value. */ public String invoiceSectionDisplayName() { @@ -461,7 +461,7 @@ public String invoiceSectionDisplayName() { /** * Get the invoiceSectionId property: The fully qualified ID that uniquely identifies an invoice section. - * + * * @return the invoiceSectionId value. */ public String invoiceSectionId() { @@ -470,7 +470,7 @@ public String invoiceSectionId() { /** * Get the invoiceSectionStatus property: Identifies the status of an invoice section. - * + * * @return the invoiceSectionStatus value. */ public InvoiceSectionState invoiceSectionStatus() { @@ -479,7 +479,7 @@ public InvoiceSectionState invoiceSectionStatus() { /** * Get the invoiceSectionStatusReasonCode property: Reason for the specified invoice section status. - * + * * @return the invoiceSectionStatusReasonCode value. */ public InvoiceSectionStateReasonCode invoiceSectionStatusReasonCode() { @@ -489,8 +489,8 @@ public InvoiceSectionStateReasonCode invoiceSectionStatusReasonCode() { /** * Get the isTransitionedBillingAccount property: Specifies if the billing account for the subscription is * transitioned from a Microsoft Online Service Program to a Microsoft Customer Agreement (MCA) account. Will be - * present and value will be true if its a transitioned billing account. - * + * present and value will be true if it's a transitioned billing account. + * * @return the isTransitionedBillingAccount value. */ public Boolean isTransitionedBillingAccount() { @@ -499,7 +499,7 @@ public Boolean isTransitionedBillingAccount() { /** * Get the skuDescription property: The sku description. - * + * * @return the skuDescription value. */ public String skuDescription() { @@ -508,7 +508,7 @@ public String skuDescription() { /** * Get the skuId property: The ID that uniquely identifies a sku. - * + * * @return the skuId value. */ public String skuId() { @@ -517,7 +517,7 @@ public String skuId() { /** * Get the subscriptionBillingStatus property: The subscription status. - * + * * @return the subscriptionBillingStatus value. */ public BillingSubscriptionStatus subscriptionBillingStatus() { @@ -526,7 +526,7 @@ public BillingSubscriptionStatus subscriptionBillingStatus() { /** * Get the subscriptionBillingStatusDetails property: The reason codes for the subscription status. - * + * * @return the subscriptionBillingStatusDetails value. */ public List subscriptionBillingStatusDetails() { @@ -535,7 +535,7 @@ public List subscriptionBillingStatusDetails() /** * Get the subscriptionBillingType property: The type of billing subscription. - * + * * @return the subscriptionBillingType value. */ public SubscriptionBillingType subscriptionBillingType() { @@ -546,7 +546,7 @@ public SubscriptionBillingType subscriptionBillingType() { * Get the subscriptionServiceUsageAddress property: The address of the individual or organization where service * subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be * updated via patch. - * + * * @return the subscriptionServiceUsageAddress value. */ public BillingPropertyPropertiesSubscriptionServiceUsageAddress subscriptionServiceUsageAddress() { @@ -557,7 +557,7 @@ public BillingPropertyPropertiesSubscriptionServiceUsageAddress subscriptionServ * Set the subscriptionServiceUsageAddress property: The address of the individual or organization where service * subscription is being used. Available for agreement type Microsoft Online Services Program. This property can be * updated via patch. - * + * * @param subscriptionServiceUsageAddress the subscriptionServiceUsageAddress value to set. * @return the BillingPropertyProperties object itself. */ @@ -569,7 +569,7 @@ public BillingPropertyProperties withSubscriptionServiceUsageAddress( /** * Get the subscriptionWorkloadType property: The Azure workload type of the subscription. - * + * * @return the subscriptionWorkloadType value. */ public SubscriptionWorkloadType subscriptionWorkloadType() { @@ -579,7 +579,7 @@ public SubscriptionWorkloadType subscriptionWorkloadType() { /** * Get the enrollmentDetails property: The enrollment details for the subscription. Available for billing accounts * with agreement type Enterprise Agreement. - * + * * @return the enrollmentDetails value. */ public BillingPropertyPropertiesEnrollmentDetails enrollmentDetails() { @@ -589,7 +589,7 @@ public BillingPropertyPropertiesEnrollmentDetails enrollmentDetails() { /** * Set the enrollmentDetails property: The enrollment details for the subscription. Available for billing accounts * with agreement type Enterprise Agreement. - * + * * @param enrollmentDetails the enrollmentDetails value to set. * @return the BillingPropertyProperties object itself. */ @@ -601,7 +601,7 @@ public BillingPropertyPropertiesEnrollmentDetails enrollmentDetails() { /** * Get the isAccountAdmin property: Indicates whether user is the account admin. - * + * * @return the isAccountAdmin value. */ public Boolean isAccountAdmin() { @@ -610,7 +610,7 @@ public Boolean isAccountAdmin() { /** * Get the productId property: The ID that uniquely identifies a product. - * + * * @return the productId value. */ public String productId() { @@ -619,7 +619,7 @@ public String productId() { /** * Get the productName property: The ID that uniquely identifies a product. - * + * * @return the productName value. */ public String productName() { @@ -628,7 +628,7 @@ public String productName() { /** * Validates the instance. - * + * * @throws IllegalArgumentException thrown if the instance is not valid. */ public void validate() { @@ -660,7 +660,7 @@ public JsonWriter toJson(JsonWriter jsonWriter) throws IOException { /** * Reads an instance of BillingPropertyProperties from the JsonReader. - * + * * @param jsonReader The JsonReader being read. * @return An instance of BillingPropertyProperties if the JsonReader was pointing to an instance of it, or null if * it was pointing to JSON null. diff --git a/sdk/communication/azure-communication-identity/README.md b/sdk/communication/azure-communication-identity/README.md index 9fc198e11525..6851deff2958 100644 --- a/sdk/communication/azure-communication-identity/README.md +++ b/sdk/communication/azure-communication-identity/README.md @@ -127,7 +127,7 @@ also takes in a list of `CommunicationTokenScope`. Scope options include: - `CHAT` (Use this for full access to Chat APIs) - `VOIP` (Use this for full access to Calling APIs) - `CHAT_JOIN` (Access to Chat APIs but without the authorization to create, delete or update chat threads) -- `CHAT_JOIN_LIMITED` (A more limited version of CHAT_JOIN that doesn't allow to add or remove participants) +- `CHAT_JOIN_LIMITED` (A more limited version of CHAT_JOIN that doesn't allow adding or removing participants) - `VOIP_JOIN` (Access to Calling APIs but without the authorization to start new calls) ```java readme-sample-issueUserToken diff --git a/sdk/compute/azure-resourcemanager-compute/src/test/java/com/azure/resourcemanager/compute/VirtualMachineScaleSetOperationsTests.java b/sdk/compute/azure-resourcemanager-compute/src/test/java/com/azure/resourcemanager/compute/VirtualMachineScaleSetOperationsTests.java index b0ead52796fa..4594b6476891 100644 --- a/sdk/compute/azure-resourcemanager-compute/src/test/java/com/azure/resourcemanager/compute/VirtualMachineScaleSetOperationsTests.java +++ b/sdk/compute/azure-resourcemanager-compute/src/test/java/com/azure/resourcemanager/compute/VirtualMachineScaleSetOperationsTests.java @@ -680,7 +680,7 @@ public void canCreateTwoRegionalVMScaleSetsWithDifferentPoolOfZoneResilientLoadB // Zone resilient resource -> resources deployed in all zones by the service and it will be served by all AZs // all the time. // ZoneResilientLoadBalancer -> STANDARD LB -> [Since service deploy them to all zones, user don't have to set - // zone explicitly, even if he does its a constrain as user can set only one zone at this time] + // zone explicitly, even if he does it's a constrain as user can set only one zone at this time] Region region2 = Region.US_EAST2; diff --git a/sdk/cosmos/azure-cosmos-encryption/src/main/java/com/azure/cosmos/encryption/implementation/mdesrc/cryptography/SqlSerializerUtil.java b/sdk/cosmos/azure-cosmos-encryption/src/main/java/com/azure/cosmos/encryption/implementation/mdesrc/cryptography/SqlSerializerUtil.java index 4052be390458..fc436d18b439 100644 --- a/sdk/cosmos/azure-cosmos-encryption/src/main/java/com/azure/cosmos/encryption/implementation/mdesrc/cryptography/SqlSerializerUtil.java +++ b/sdk/cosmos/azure-cosmos-encryption/src/main/java/com/azure/cosmos/encryption/implementation/mdesrc/cryptography/SqlSerializerUtil.java @@ -1312,7 +1312,7 @@ static byte[] getNormalizedTemporal(GregorianCalendar cal, int subSecondNanos, i if (SSType.TIME == ssType) { --scaledNanos; } - // If the type is datetime2 or datetimeoffset, truncate only if its the max value supported + // If the type is datetime2 or datetimeoffset, truncate only if it's the max value supported else { assert SSType.DATETIME2 == ssType || SSType.DATETIMEOFFSET == ssType : "Unexpected SSType: " + ssType; diff --git a/sdk/cosmos/azure-cosmos-spark_3_2-12/docs/migration.md b/sdk/cosmos/azure-cosmos-spark_3_2-12/docs/migration.md index 556be2864ff8..3c76cd710822 100644 --- a/sdk/cosmos/azure-cosmos-spark_3_2-12/docs/migration.md +++ b/sdk/cosmos/azure-cosmos-spark_3_2-12/docs/migration.md @@ -20,7 +20,7 @@ | WriteThroughputBudget | spark.cosmos.throughputControl.* | See the [Throughput control](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos-spark_3_2-12/docs/scenarios/Ingestion.md#throughput-control) section for more information | | MaxIngestionTaskParallelism | n/a | Not relevant anymore - just remove this config entry | | query_pagesize | n/a | Not relevant anymore - just remove this config entry | -| query_custom | spark.cosmos.read.customQuery | When provided the custom query will be processed against the Cosmos endpoint instead of dynamically generating the query via predicate push down. Usually it is recommended to rely on Spark's predicate push down because that will allow to generate the most efficient set of filters based on the query plan. But there are a couple of of predicates like aggregates (count, group by, avg, sum etc.) that cannot be pushed down yet (at least in Spark 3.1) - so the custom query is a fallback to allow them to be pushed into the query sent to Cosmos. | +| query_custom | spark.cosmos.read.customQuery | When provided the custom query will be processed against the Cosmos endpoint instead of dynamically generating the query via predicate push down. Usually it is recommended to rely on Spark's predicate push down because that will allow generating the most efficient set of filters based on the query plan. But there are a couple of predicates like aggregates (count, group by, avg, sum etc.) that cannot be pushed down yet (at least in Spark 3.1) - so the custom query is a fallback to allow them to be pushed into the query sent to Cosmos. | | readchangefeed | n/a | See the `"One DataSource rules them all" vs. separate DataSource for ChangeFeed` section below. For change feed we now have a dedicated DataSource | | changefeedqueryname | n/a | See the `Structured streaming` section below. Bookmarks/offsets are not stored in a proprietary way by the connector any longer but by Spark's Metadata Store | | changefeedcheckpointlocation | n/a | See the `Structured streaming` section below. Bookmarks/offsets are not stored in a proprietary way by the connector any longer but by Spark's Metadata Store | diff --git a/sdk/cosmos/azure-cosmos-spark_3_2-12/docs/scenarios/Ingestion.md b/sdk/cosmos/azure-cosmos-spark_3_2-12/docs/scenarios/Ingestion.md index 292b74e2729b..1a2e3e35acc6 100644 --- a/sdk/cosmos/azure-cosmos-spark_3_2-12/docs/scenarios/Ingestion.md +++ b/sdk/cosmos/azure-cosmos-spark_3_2-12/docs/scenarios/Ingestion.md @@ -65,7 +65,7 @@ Different write strategies in the `spark.cosmos.write.strategy` configuration pa - `ItemOverwrite` (the default write strategy): All items of the source DataFrame will be inserted or updated. If the Cosmos DB container contains a document with the same pk+id, it will be updated otherwise a new documented will be created. Existing documents will be replaced independent of when they have been last updated or if the content would actually change. - `ItemAppend`: For all items in the source DataFrame an attempt will be made to insert a new document - if a document with the same pk+id exists already, the 409/Conflict response will be ignore and the existing document will not be modified. - `ItemOverwriteIfNotModified`: If an etag value exists it will attempt to replace the document with etag pre-condition. If the document changed since being read into the source DataFrame - identified by precondition failure - the update is skipped and the document is not updated with the content of the data frame row. This write strategy can be used when it is important to not override changes made by a different job/application between the time when spark read the document from Cosmos DB. -- `ItemDelete`: Will delete all documents with a pk+id as in the source DataFrame. This is the most robust option to bulk delete documents in Cosmos DB - deletes in Cosmos DB are having the same high RU charge as replacing a document - so deleting a large number of documents can be challenging - using this write strategy will allow to delete documents in bulk - and also use the client throughput control mechanism also used for bulk ingestion to limit the "RU budget" for this operations. +- `ItemDelete`: Will delete all documents with a pk+id as in the source DataFrame. This is the most robust option to bulk delete documents in Cosmos DB - deletes in Cosmos DB are having the same high RU charge as replacing a document - so deleting a large number of documents can be challenging - using this write strategy will allow deleting documents in bulk - and also use the client throughput control mechanism also used for bulk ingestion to limit the "RU budget" for these operations. - `ItemDeleteIfNotModified`: Same as `ItemDelete` - except that it will only delete documents when the etag value hasn't changed. This is helpful when trying to delete documents based on a query. You would read the result of the query into a source DataFrame - then "write" it to Cosmos DB with the `ItemDeleteIfNotModified` write strategy. Using the etag pre-condition check will avoid deleting documents that have been changed since running the query (because the updated document might not match the query filter conditions anymore) ### Retry policies and data validation diff --git a/sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/rx/OrderbyDocumentQueryTest.java b/sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/rx/OrderbyDocumentQueryTest.java index b4df631aed8b..f3a98525c587 100644 --- a/sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/rx/OrderbyDocumentQueryTest.java +++ b/sdk/cosmos/azure-cosmos-tests/src/test/java/com/azure/cosmos/rx/OrderbyDocumentQueryTest.java @@ -325,7 +325,7 @@ public void queryOrderByMixedTypes(String sortOrder) throws Exception { List partitionKeyRanges = getPartitionKeyRanges(createdCollection.getId(), BridgeInternal .getContextClient(this.client)); - // Ensure its a cross partition query + // Ensure it's a cross partition query assertThat(partitionKeyRanges.size()).isGreaterThan(1); // We are inserting documents with int, float, string, array, object and missing propMixed. String query = "SELECT * FROM r ORDER BY r.propMixed "; diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/directconnectivity/rntbd/RntbdClientChannelPool.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/directconnectivity/rntbd/RntbdClientChannelPool.java index e3babbd65b07..7f0eda191bab 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/directconnectivity/rntbd/RntbdClientChannelPool.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/directconnectivity/rntbd/RntbdClientChannelPool.java @@ -114,7 +114,7 @@ * - Possible that acquisition order might differ the ChannelWrite order * - MAX_REQUESTS_ENDPOINT: Truth managed by RntbdRequestManager in Channel.Pipeline * - RequestManager only known when the Channel process them. - * - In-flight scheduled ones are unknown -> its a SOFT BOUND + * - In-flight scheduled ones are unknown -> it's a SOFT BOUND * */ @JsonSerialize(using = RntbdClientChannelPool.JsonSerializer.class) diff --git a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/query/OrderByUtils.java b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/query/OrderByUtils.java index f60ef1e8aee8..f8be92cbf0f8 100644 --- a/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/query/OrderByUtils.java +++ b/sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/query/OrderByUtils.java @@ -122,7 +122,7 @@ public Flux> apply(Flux.Do queryItems.add(queryItem); } - // Check if its the same orderby item from the token + // Check if it's the same orderby item from the token long cmp = 0; for (int i = 0; i < sortOrders.size(); i++) { cmp = ItemComparator.getInstance().compare(orderByContinuationToken.getOrderByItems()[i].getItem(), diff --git a/sdk/resourcemanagerhybrid/azure-resourcemanager-compute/src/test/java/com/azure/resourcemanager/compute/VirtualMachineScaleSetOperationsTests.java b/sdk/resourcemanagerhybrid/azure-resourcemanager-compute/src/test/java/com/azure/resourcemanager/compute/VirtualMachineScaleSetOperationsTests.java index 94cecf2fdb49..1c88ede3a612 100644 --- a/sdk/resourcemanagerhybrid/azure-resourcemanager-compute/src/test/java/com/azure/resourcemanager/compute/VirtualMachineScaleSetOperationsTests.java +++ b/sdk/resourcemanagerhybrid/azure-resourcemanager-compute/src/test/java/com/azure/resourcemanager/compute/VirtualMachineScaleSetOperationsTests.java @@ -693,7 +693,7 @@ public void canCreateVirtualMachineScaleSet() throws Exception { // Zone resilient resource -> resources deployed in all zones by the service and it will be served by all AZs // all the time. // ZoneResilientLoadBalancer -> STANDARD LB -> [Since service deploy them to all zones, user don't have to set - // zone explicitly, even if he does its a constrain as user can set only one zone at this time] + // zone explicitly, even if he does it's a constrain as user can set only one zone at this time] Region region2 = locationOrDefault(Region.US_EAST2); diff --git a/sdk/resourcemanagerhybrid/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/dag/TaskItem.java b/sdk/resourcemanagerhybrid/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/dag/TaskItem.java index d742121d1b3c..2a6df0ea2d49 100644 --- a/sdk/resourcemanagerhybrid/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/dag/TaskItem.java +++ b/sdk/resourcemanagerhybrid/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/dag/TaskItem.java @@ -26,7 +26,7 @@ public interface TaskItem { /** * @return true if the publisher returned by invokeAsync(cxt) is a hot observable, - * false if its a cold publisher. + * false if it's a cold publisher. */ boolean isHot(); diff --git a/sdk/resources/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/dag/TaskItem.java b/sdk/resources/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/dag/TaskItem.java index aa14108494ab..9ea36cc9d000 100644 --- a/sdk/resources/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/dag/TaskItem.java +++ b/sdk/resources/azure-resourcemanager-resources/src/main/java/com/azure/resourcemanager/resources/fluentcore/dag/TaskItem.java @@ -30,7 +30,7 @@ public interface TaskItem { * Check whether is a hot observable. * * @return true if the publisher returned by invokeAsync(cxt) is a hot observable, - * false if its a cold publisher. + * false if it's a cold publisher. */ boolean isHot(); diff --git a/sdk/storage/CONTRIBUTING.md b/sdk/storage/CONTRIBUTING.md index d399f756ddbd..c060dcf1326f 100644 --- a/sdk/storage/CONTRIBUTING.md +++ b/sdk/storage/CONTRIBUTING.md @@ -9,7 +9,7 @@ Thank you for your interest in contributing to Azure SDK for Java. - To make code changes, or contribute something new, please follow the [GitHub Forks / Pull requests model](https://help.github.com/articles/fork-a-repo/): Fork the repo, make the change and propose it back by submitting a pull request. -- Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#testing-for-spotbugs-and-checkstyle-issues) to learn about how Azure SDK for java generates CheckStyle, SpotBugs, Jacoco, and JavaDoc reports. +- Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#testing-for-spotbugs-and-checkstyle-issues) to learn about how Azure SDK for Java generates CheckStyle, SpotBugs, Jacoco, and JavaDoc reports. - There are two Maven projects in the repo. Refer to the [wiki](https://github.com/Azure/azure-sdk-for-java/wiki/Building#pomclientxml-vs-pomdataxml) to learn about project structure for each.