From 682a5ffe2604e14fa808a5da01d88de9407a36c7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Mon, 8 Feb 2021 16:48:13 -0800 Subject: [PATCH] docs: generate sample code in the Java microgenerator (#381) This PR was generated using Autosynth. :rainbow: Synth log will be available here: https://source.cloud.google.com/results/invocations/87b59d0a-bf78-4195-b15b-04bd3003213a/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 356341083 Source-Link: https://github.com/googleapis/googleapis/commit/8d8c008e56f1af31d57f75561e0f1848ffb29eeb --- .../budgets/v1/BudgetServiceClient.java | 245 ++++++++++++++++++ .../billing/budgets/v1/package-info.java | 8 + .../budgets/v1beta1/BudgetServiceClient.java | 160 ++++++++++++ .../billing/budgets/v1beta1/package-info.java | 11 + synth.metadata | 10 +- 5 files changed, 429 insertions(+), 5 deletions(-) diff --git a/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1/BudgetServiceClient.java b/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1/BudgetServiceClient.java index 8a9a5771..91af6b67 100644 --- a/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1/BudgetServiceClient.java +++ b/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1/BudgetServiceClient.java @@ -44,6 +44,14 @@ *

This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. Sample code to get started: * + *

{@code
+ * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+ *   BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
+ *   Budget budget = Budget.newBuilder().build();
+ *   Budget response = budgetServiceClient.createBudget(parent, budget);
+ * }
+ * }
+ * *

Note: close() needs to be called on the BudgetServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * @@ -148,6 +156,16 @@ public BudgetServiceStub getStub() { * Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more * information on the limits of the number of budgets you can create. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
+   *   Budget budget = Budget.newBuilder().build();
+   *   Budget response = budgetServiceClient.createBudget(parent, budget);
+   * }
+   * }
+ * * @param parent Required. The name of the billing account to create the budget in. Values are of * the form `billingAccounts/{billingAccountId}`. * @param budget Required. Budget to create. @@ -167,6 +185,16 @@ public final Budget createBudget(BillingAccountName parent, Budget budget) { * Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more * information on the limits of the number of budgets you can create. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   String parent = BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString();
+   *   Budget budget = Budget.newBuilder().build();
+   *   Budget response = budgetServiceClient.createBudget(parent, budget);
+   * }
+   * }
+ * * @param parent Required. The name of the billing account to create the budget in. Values are of * the form `billingAccounts/{billingAccountId}`. * @param budget Required. Budget to create. @@ -183,6 +211,19 @@ public final Budget createBudget(String parent, Budget budget) { * Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more * information on the limits of the number of budgets you can create. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   CreateBudgetRequest request =
+   *       CreateBudgetRequest.newBuilder()
+   *           .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .setBudget(Budget.newBuilder().build())
+   *           .build();
+   *   Budget response = budgetServiceClient.createBudget(request);
+   * }
+   * }
+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -196,6 +237,19 @@ public final Budget createBudget(CreateBudgetRequest request) { * information on the limits of the number of budgets you can create. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   CreateBudgetRequest request =
+   *       CreateBudgetRequest.newBuilder()
+   *           .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .setBudget(Budget.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = budgetServiceClient.createBudgetCallable().futureCall(request);
+   *   // Do something.
+   *   Budget response = future.get();
+   * }
+   * }
*/ public final UnaryCallable createBudgetCallable() { return stub.createBudgetCallable(); @@ -208,6 +262,16 @@ public final UnaryCallable createBudgetCallable() { *

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on * this API. Budget fields that are not exposed in this API will not be changed by this method. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   Budget budget = Budget.newBuilder().build();
+   *   FieldMask updateMask = FieldMask.newBuilder().build();
+   *   Budget response = budgetServiceClient.updateBudget(budget, updateMask);
+   * }
+   * }
+ * * @param budget Required. The updated budget object. The budget to update is specified by the * budget name in the budget. * @param updateMask Optional. Indicates which fields in the provided budget to update. Read-only @@ -230,6 +294,19 @@ public final Budget updateBudget(Budget budget, FieldMask updateMask) { *

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on * this API. Budget fields that are not exposed in this API will not be changed by this method. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   UpdateBudgetRequest request =
+   *       UpdateBudgetRequest.newBuilder()
+   *           .setBudget(Budget.newBuilder().build())
+   *           .setUpdateMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   Budget response = budgetServiceClient.updateBudget(request);
+   * }
+   * }
+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -245,6 +322,19 @@ public final Budget updateBudget(UpdateBudgetRequest request) { * this API. Budget fields that are not exposed in this API will not be changed by this method. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   UpdateBudgetRequest request =
+   *       UpdateBudgetRequest.newBuilder()
+   *           .setBudget(Budget.newBuilder().build())
+   *           .setUpdateMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = budgetServiceClient.updateBudgetCallable().futureCall(request);
+   *   // Do something.
+   *   Budget response = future.get();
+   * }
+   * }
*/ public final UnaryCallable updateBudgetCallable() { return stub.updateBudgetCallable(); @@ -258,6 +348,15 @@ public final UnaryCallable updateBudgetCallable() { * this API. When reading from the API, you will not see these fields in the return value, though * they may have been set in the Cloud Console. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   BudgetName name = BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]");
+   *   Budget response = budgetServiceClient.getBudget(name);
+   * }
+   * }
+ * * @param name Required. Name of budget to get. Values are of the form * `billingAccounts/{billingAccountId}/budgets/{budgetId}`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -276,6 +375,15 @@ public final Budget getBudget(BudgetName name) { * this API. When reading from the API, you will not see these fields in the return value, though * they may have been set in the Cloud Console. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   String name = BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString();
+   *   Budget response = budgetServiceClient.getBudget(name);
+   * }
+   * }
+ * * @param name Required. Name of budget to get. Values are of the form * `billingAccounts/{billingAccountId}/budgets/{budgetId}`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -293,6 +401,18 @@ public final Budget getBudget(String name) { * this API. When reading from the API, you will not see these fields in the return value, though * they may have been set in the Cloud Console. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   GetBudgetRequest request =
+   *       GetBudgetRequest.newBuilder()
+   *           .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .build();
+   *   Budget response = budgetServiceClient.getBudget(request);
+   * }
+   * }
+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -309,6 +429,18 @@ public final Budget getBudget(GetBudgetRequest request) { * they may have been set in the Cloud Console. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   GetBudgetRequest request =
+   *       GetBudgetRequest.newBuilder()
+   *           .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .build();
+   *   ApiFuture future = budgetServiceClient.getBudgetCallable().futureCall(request);
+   *   // Do something.
+   *   Budget response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getBudgetCallable() { return stub.getBudgetCallable(); @@ -322,6 +454,17 @@ public final UnaryCallable getBudgetCallable() { * this API. When reading from the API, you will not see these fields in the return value, though * they may have been set in the Cloud Console. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
+   *   for (Budget element : budgetServiceClient.listBudgets(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent Required. Name of billing account to list budgets under. Values are of the form * `billingAccounts/{billingAccountId}`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -342,6 +485,17 @@ public final ListBudgetsPagedResponse listBudgets(BillingAccountName parent) { * this API. When reading from the API, you will not see these fields in the return value, though * they may have been set in the Cloud Console. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   String parent = BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString();
+   *   for (Budget element : budgetServiceClient.listBudgets(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent Required. Name of billing account to list budgets under. Values are of the form * `billingAccounts/{billingAccountId}`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -359,6 +513,22 @@ public final ListBudgetsPagedResponse listBudgets(String parent) { * this API. When reading from the API, you will not see these fields in the return value, though * they may have been set in the Cloud Console. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   ListBudgetsRequest request =
+   *       ListBudgetsRequest.newBuilder()
+   *           .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   for (Budget element : budgetServiceClient.listBudgets(request).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -375,6 +545,22 @@ public final ListBudgetsPagedResponse listBudgets(ListBudgetsRequest request) { * they may have been set in the Cloud Console. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   ListBudgetsRequest request =
+   *       ListBudgetsRequest.newBuilder()
+   *           .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   ApiFuture future = budgetServiceClient.listBudgetsPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (Budget element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listBudgetsPagedCallable() { @@ -390,6 +576,23 @@ public final ListBudgetsPagedResponse listBudgets(ListBudgetsRequest request) { * they may have been set in the Cloud Console. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   while (true) {
+   *     ListBudgetsResponse response = budgetServiceClient.listBudgetsCallable().call(request);
+   *     for (Budget element : response.getResponsesList()) {
+   *       // doThingsWith(element);
+   *     }
+   *     String nextPageToken = response.getNextPageToken();
+   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
+   *       request = request.toBuilder().setPageToken(nextPageToken).build();
+   *     } else {
+   *       break;
+   *     }
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listBudgetsCallable() { return stub.listBudgetsCallable(); @@ -399,6 +602,15 @@ public final UnaryCallable listBudgetsC /** * Deletes a budget. Returns successfully if already deleted. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   BudgetName name = BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]");
+   *   budgetServiceClient.deleteBudget(name);
+   * }
+   * }
+ * * @param name Required. Name of the budget to delete. Values are of the form * `billingAccounts/{billingAccountId}/budgets/{budgetId}`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -413,6 +625,15 @@ public final void deleteBudget(BudgetName name) { /** * Deletes a budget. Returns successfully if already deleted. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   String name = BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString();
+   *   budgetServiceClient.deleteBudget(name);
+   * }
+   * }
+ * * @param name Required. Name of the budget to delete. Values are of the form * `billingAccounts/{billingAccountId}/budgets/{budgetId}`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -426,6 +647,18 @@ public final void deleteBudget(String name) { /** * Deletes a budget. Returns successfully if already deleted. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   DeleteBudgetRequest request =
+   *       DeleteBudgetRequest.newBuilder()
+   *           .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .build();
+   *   budgetServiceClient.deleteBudget(request);
+   * }
+   * }
+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -438,6 +671,18 @@ public final void deleteBudget(DeleteBudgetRequest request) { * Deletes a budget. Returns successfully if already deleted. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   DeleteBudgetRequest request =
+   *       DeleteBudgetRequest.newBuilder()
+   *           .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .build();
+   *   ApiFuture future = budgetServiceClient.deleteBudgetCallable().futureCall(request);
+   *   // Do something.
+   *   future.get();
+   * }
+   * }
*/ public final UnaryCallable deleteBudgetCallable() { return stub.deleteBudgetCallable(); diff --git a/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1/package-info.java b/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1/package-info.java index 763b60f6..8c972e29 100644 --- a/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1/package-info.java +++ b/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1/package-info.java @@ -23,6 +23,14 @@ * and rules to execute as we track spend against that plan. * *

Sample for BudgetServiceClient: + * + *

{@code
+ * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+ *   BillingAccountName parent = BillingAccountName.of("[BILLING_ACCOUNT]");
+ *   Budget budget = Budget.newBuilder().build();
+ *   Budget response = budgetServiceClient.createBudget(parent, budget);
+ * }
+ * }
*/ @Generated("by gapic-generator-java") package com.google.cloud.billing.budgets.v1; diff --git a/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceClient.java b/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceClient.java index d1f1e635..fb65d741 100644 --- a/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceClient.java +++ b/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceClient.java @@ -43,6 +43,17 @@ *

This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. Sample code to get started: * + *

{@code
+ * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+ *   CreateBudgetRequest request =
+ *       CreateBudgetRequest.newBuilder()
+ *           .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+ *           .setBudget(Budget.newBuilder().build())
+ *           .build();
+ *   Budget response = budgetServiceClient.createBudget(request);
+ * }
+ * }
+ * *

Note: close() needs to be called on the BudgetServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * @@ -148,6 +159,19 @@ public BudgetServiceStub getStub() { * Creates a new budget. See <a href="https://cloud.google.com/billing/quotas">Quotas and * limits</a> for more information on the limits of the number of budgets you can create. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   CreateBudgetRequest request =
+   *       CreateBudgetRequest.newBuilder()
+   *           .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .setBudget(Budget.newBuilder().build())
+   *           .build();
+   *   Budget response = budgetServiceClient.createBudget(request);
+   * }
+   * }
+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -161,6 +185,19 @@ public final Budget createBudget(CreateBudgetRequest request) { * limits</a> for more information on the limits of the number of budgets you can create. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   CreateBudgetRequest request =
+   *       CreateBudgetRequest.newBuilder()
+   *           .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .setBudget(Budget.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = budgetServiceClient.createBudgetCallable().futureCall(request);
+   *   // Do something.
+   *   Budget response = future.get();
+   * }
+   * }
*/ public final UnaryCallable createBudgetCallable() { return stub.createBudgetCallable(); @@ -173,6 +210,19 @@ public final UnaryCallable createBudgetCallable() { *

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on * this API. Budget fields that are not exposed in this API will not be changed by this method. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   UpdateBudgetRequest request =
+   *       UpdateBudgetRequest.newBuilder()
+   *           .setBudget(Budget.newBuilder().build())
+   *           .setUpdateMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   Budget response = budgetServiceClient.updateBudget(request);
+   * }
+   * }
+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -188,6 +238,19 @@ public final Budget updateBudget(UpdateBudgetRequest request) { * this API. Budget fields that are not exposed in this API will not be changed by this method. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   UpdateBudgetRequest request =
+   *       UpdateBudgetRequest.newBuilder()
+   *           .setBudget(Budget.newBuilder().build())
+   *           .setUpdateMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = budgetServiceClient.updateBudgetCallable().futureCall(request);
+   *   // Do something.
+   *   Budget response = future.get();
+   * }
+   * }
*/ public final UnaryCallable updateBudgetCallable() { return stub.updateBudgetCallable(); @@ -201,6 +264,18 @@ public final UnaryCallable updateBudgetCallable() { * this API. When reading from the API, you will not see these fields in the return value, though * they may have been set in the Cloud Console. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   GetBudgetRequest request =
+   *       GetBudgetRequest.newBuilder()
+   *           .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .build();
+   *   Budget response = budgetServiceClient.getBudget(request);
+   * }
+   * }
+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -217,6 +292,18 @@ public final Budget getBudget(GetBudgetRequest request) { * they may have been set in the Cloud Console. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   GetBudgetRequest request =
+   *       GetBudgetRequest.newBuilder()
+   *           .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .build();
+   *   ApiFuture future = budgetServiceClient.getBudgetCallable().futureCall(request);
+   *   // Do something.
+   *   Budget response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getBudgetCallable() { return stub.getBudgetCallable(); @@ -230,6 +317,22 @@ public final UnaryCallable getBudgetCallable() { * this API. When reading from the API, you will not see these fields in the return value, though * they may have been set in the Cloud Console. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   ListBudgetsRequest request =
+   *       ListBudgetsRequest.newBuilder()
+   *           .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   for (Budget element : budgetServiceClient.listBudgets(request).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -246,6 +349,22 @@ public final ListBudgetsPagedResponse listBudgets(ListBudgetsRequest request) { * they may have been set in the Cloud Console. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   ListBudgetsRequest request =
+   *       ListBudgetsRequest.newBuilder()
+   *           .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   ApiFuture future = budgetServiceClient.listBudgetsPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (Budget element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listBudgetsPagedCallable() { @@ -261,6 +380,23 @@ public final ListBudgetsPagedResponse listBudgets(ListBudgetsRequest request) { * they may have been set in the Cloud Console. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   while (true) {
+   *     ListBudgetsResponse response = budgetServiceClient.listBudgetsCallable().call(request);
+   *     for (Budget element : response.getResponsesList()) {
+   *       // doThingsWith(element);
+   *     }
+   *     String nextPageToken = response.getNextPageToken();
+   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
+   *       request = request.toBuilder().setPageToken(nextPageToken).build();
+   *     } else {
+   *       break;
+   *     }
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listBudgetsCallable() { return stub.listBudgetsCallable(); @@ -270,6 +406,18 @@ public final UnaryCallable listBudgetsC /** * Deletes a budget. Returns successfully if already deleted. * + *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   DeleteBudgetRequest request =
+   *       DeleteBudgetRequest.newBuilder()
+   *           .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .build();
+   *   budgetServiceClient.deleteBudget(request);
+   * }
+   * }
+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -282,6 +430,18 @@ public final void deleteBudget(DeleteBudgetRequest request) { * Deletes a budget. Returns successfully if already deleted. * *

Sample code: + * + *

{@code
+   * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+   *   DeleteBudgetRequest request =
+   *       DeleteBudgetRequest.newBuilder()
+   *           .setName(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+   *           .build();
+   *   ApiFuture future = budgetServiceClient.deleteBudgetCallable().futureCall(request);
+   *   // Do something.
+   *   future.get();
+   * }
+   * }
*/ public final UnaryCallable deleteBudgetCallable() { return stub.deleteBudgetCallable(); diff --git a/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/package-info.java b/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/package-info.java index e7e3ac95..0ff7a5c7 100644 --- a/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/package-info.java +++ b/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/package-info.java @@ -23,6 +23,17 @@ * and rules to execute as we track spend against that plan. * *

Sample for BudgetServiceClient: + * + *

{@code
+ * try (BudgetServiceClient budgetServiceClient = BudgetServiceClient.create()) {
+ *   CreateBudgetRequest request =
+ *       CreateBudgetRequest.newBuilder()
+ *           .setParent(BudgetName.of("[BILLING_ACCOUNT]", "[BUDGET]").toString())
+ *           .setBudget(Budget.newBuilder().build())
+ *           .build();
+ *   Budget response = budgetServiceClient.createBudget(request);
+ * }
+ * }
*/ @Generated("by gapic-generator-java") package com.google.cloud.billing.budgets.v1beta1; diff --git a/synth.metadata b/synth.metadata index bbdff3b6..14e80bc2 100644 --- a/synth.metadata +++ b/synth.metadata @@ -4,23 +4,23 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/java-billingbudgets.git", - "sha": "e312a4e61c37d72ecd2732747d2155580cfaa996" + "sha": "79785b2122cd6acc6f7cc42f41ef780d197dc06a" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "91e206bcfeaf8948ea03fe3cb1b7616108496cd3", - "internalRef": "350949863" + "sha": "8d8c008e56f1af31d57f75561e0f1848ffb29eeb", + "internalRef": "356341083" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "91e206bcfeaf8948ea03fe3cb1b7616108496cd3", - "internalRef": "350949863" + "sha": "8d8c008e56f1af31d57f75561e0f1848ffb29eeb", + "internalRef": "356341083" } }, {