From c6549ef44581613efa5ef2f6e965bf8faea741f4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Mon, 8 Feb 2021 16:48:09 -0800 Subject: [PATCH] docs: generate sample code in the Java microgenerator (#324) This PR was generated using Autosynth. :rainbow: Synth log will be available here: https://source.cloud.google.com/results/invocations/89bbfe8d-0991-4bf5-9ea3-b2a25748a524/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 356341083 Source-Link: https://github.com/googleapis/googleapis/commit/8d8c008e56f1af31d57f75561e0f1848ffb29eeb --- .../v1/AccessApprovalAdminClient.java | 251 ++++++++++++++++++ .../cloud/accessapproval/v1/package-info.java | 7 + .../v1/stub/AccessApprovalStubSettings.java | 9 +- synth.metadata | 6 +- 4 files changed, 266 insertions(+), 7 deletions(-) diff --git a/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminClient.java b/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminClient.java index dcf37417..b840f808 100644 --- a/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminClient.java +++ b/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminClient.java @@ -70,6 +70,13 @@ *

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 (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+ *   String name = "name3373707";
+ *   ApprovalRequest response = accessApprovalAdminClient.getApprovalRequest(name);
+ * }
+ * }
+ * *

Note: close() needs to be called on the AccessApprovalAdminClient object to clean up resources * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). @@ -177,6 +184,18 @@ public AccessApprovalStub getStub() { * Lists approval requests associated with a project, folder, or organization. Approval requests * can be filtered by state (pending, active, dismissed). The order is reverse chronological. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   String parent = "parent-995424086";
+   *   for (ApprovalRequest element :
+   *       accessApprovalAdminClient.listApprovalRequests(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent The parent resource. This may be "projects/{project_id}", "folders/{folder_id}", * or "organizations/{organization_id}". * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -192,6 +211,24 @@ public final ListApprovalRequestsPagedResponse listApprovalRequests(String paren * Lists approval requests associated with a project, folder, or organization. Approval requests * can be filtered by state (pending, active, dismissed). The order is reverse chronological. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   ListApprovalRequestsMessage request =
+   *       ListApprovalRequestsMessage.newBuilder()
+   *           .setParent("parent-995424086")
+   *           .setFilter("filter-1274492040")
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   for (ApprovalRequest element :
+   *       accessApprovalAdminClient.listApprovalRequests(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 */ @@ -206,6 +243,24 @@ public final ListApprovalRequestsPagedResponse listApprovalRequests( * can be filtered by state (pending, active, dismissed). The order is reverse chronological. * *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   ListApprovalRequestsMessage request =
+   *       ListApprovalRequestsMessage.newBuilder()
+   *           .setParent("parent-995424086")
+   *           .setFilter("filter-1274492040")
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   ApiFuture future =
+   *       accessApprovalAdminClient.listApprovalRequestsPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (ApprovalRequest element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listApprovalRequestsPagedCallable() { @@ -218,6 +273,24 @@ public final ListApprovalRequestsPagedResponse listApprovalRequests( * can be filtered by state (pending, active, dismissed). The order is reverse chronological. * *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   while (true) {
+   *     ListApprovalRequestsResponse response =
+   *         accessApprovalAdminClient.listApprovalRequestsCallable().call(request);
+   *     for (ApprovalRequest element : response.getResponsesList()) {
+   *       // doThingsWith(element);
+   *     }
+   *     String nextPageToken = response.getNextPageToken();
+   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
+   *       request = request.toBuilder().setPageToken(nextPageToken).build();
+   *     } else {
+   *       break;
+   *     }
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listApprovalRequestsCallable() { @@ -228,6 +301,15 @@ public final ListApprovalRequestsPagedResponse listApprovalRequests( /** * Gets an approval request. Returns NOT_FOUND if the request does not exist. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   String name = "name3373707";
+   *   ApprovalRequest response = accessApprovalAdminClient.getApprovalRequest(name);
+   * }
+   * }
+ * * @param name Name of the approval request to retrieve. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -241,6 +323,16 @@ public final ApprovalRequest getApprovalRequest(String name) { /** * Gets an approval request. Returns NOT_FOUND if the request does not exist. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   GetApprovalRequestMessage request =
+   *       GetApprovalRequestMessage.newBuilder().setName("name3373707").build();
+   *   ApprovalRequest response = accessApprovalAdminClient.getApprovalRequest(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 */ @@ -253,6 +345,17 @@ public final ApprovalRequest getApprovalRequest(GetApprovalRequestMessage reques * Gets an approval request. Returns NOT_FOUND if the request does not exist. * *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   GetApprovalRequestMessage request =
+   *       GetApprovalRequestMessage.newBuilder().setName("name3373707").build();
+   *   ApiFuture future =
+   *       accessApprovalAdminClient.getApprovalRequestCallable().futureCall(request);
+   *   // Do something.
+   *   ApprovalRequest response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getApprovalRequestCallable() { @@ -266,6 +369,19 @@ public final ApprovalRequest getApprovalRequest(GetApprovalRequestMessage reques *

Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request * exists but is not in a pending state. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   ApproveApprovalRequestMessage request =
+   *       ApproveApprovalRequestMessage.newBuilder()
+   *           .setName("name3373707")
+   *           .setExpireTime(Timestamp.newBuilder().build())
+   *           .build();
+   *   ApprovalRequest response = accessApprovalAdminClient.approveApprovalRequest(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 */ @@ -281,6 +397,20 @@ public final ApprovalRequest approveApprovalRequest(ApproveApprovalRequestMessag * exists but is not in a pending state. * *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   ApproveApprovalRequestMessage request =
+   *       ApproveApprovalRequestMessage.newBuilder()
+   *           .setName("name3373707")
+   *           .setExpireTime(Timestamp.newBuilder().build())
+   *           .build();
+   *   ApiFuture future =
+   *       accessApprovalAdminClient.approveApprovalRequestCallable().futureCall(request);
+   *   // Do something.
+   *   ApprovalRequest response = future.get();
+   * }
+   * }
*/ public final UnaryCallable approveApprovalRequestCallable() { @@ -298,6 +428,16 @@ public final ApprovalRequest approveApprovalRequest(ApproveApprovalRequestMessag * *

Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   DismissApprovalRequestMessage request =
+   *       DismissApprovalRequestMessage.newBuilder().setName("name3373707").build();
+   *   ApprovalRequest response = accessApprovalAdminClient.dismissApprovalRequest(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 */ @@ -317,6 +457,17 @@ public final ApprovalRequest dismissApprovalRequest(DismissApprovalRequestMessag *

Returns FAILED_PRECONDITION if the request exists but is not in a pending state. * *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   DismissApprovalRequestMessage request =
+   *       DismissApprovalRequestMessage.newBuilder().setName("name3373707").build();
+   *   ApiFuture future =
+   *       accessApprovalAdminClient.dismissApprovalRequestCallable().futureCall(request);
+   *   // Do something.
+   *   ApprovalRequest response = future.get();
+   * }
+   * }
*/ public final UnaryCallable dismissApprovalRequestCallable() { @@ -327,6 +478,15 @@ public final ApprovalRequest dismissApprovalRequest(DismissApprovalRequestMessag /** * Gets the settings associated with a project, folder, or organization. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   String name = "name3373707";
+   *   AccessApprovalSettings response = accessApprovalAdminClient.getAccessApprovalSettings(name);
+   * }
+   * }
+ * * @param name Name of the AccessApprovalSettings to retrieve. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -340,6 +500,17 @@ public final AccessApprovalSettings getAccessApprovalSettings(String name) { /** * Gets the settings associated with a project, folder, or organization. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   GetAccessApprovalSettingsMessage request =
+   *       GetAccessApprovalSettingsMessage.newBuilder().setName("name3373707").build();
+   *   AccessApprovalSettings response =
+   *       accessApprovalAdminClient.getAccessApprovalSettings(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 */ @@ -353,6 +524,17 @@ public final AccessApprovalSettings getAccessApprovalSettings( * Gets the settings associated with a project, folder, or organization. * *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   GetAccessApprovalSettingsMessage request =
+   *       GetAccessApprovalSettingsMessage.newBuilder().setName("name3373707").build();
+   *   ApiFuture future =
+   *       accessApprovalAdminClient.getAccessApprovalSettingsCallable().futureCall(request);
+   *   // Do something.
+   *   AccessApprovalSettings response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getAccessApprovalSettingsCallable() { @@ -364,6 +546,17 @@ public final AccessApprovalSettings getAccessApprovalSettings( * Updates the settings associated with a project, folder, or organization. Settings to update are * determined by the value of field_mask. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   AccessApprovalSettings settings = AccessApprovalSettings.newBuilder().build();
+   *   FieldMask updateMask = FieldMask.newBuilder().build();
+   *   AccessApprovalSettings response =
+   *       accessApprovalAdminClient.updateAccessApprovalSettings(settings, updateMask);
+   * }
+   * }
+ * * @param settings The new AccessApprovalSettings. * @param updateMask The update mask applies to the settings. Only the top level fields of * AccessApprovalSettings (notification_emails & enrolled_services) are supported. For @@ -389,6 +582,20 @@ public final AccessApprovalSettings updateAccessApprovalSettings( * Updates the settings associated with a project, folder, or organization. Settings to update are * determined by the value of field_mask. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   UpdateAccessApprovalSettingsMessage request =
+   *       UpdateAccessApprovalSettingsMessage.newBuilder()
+   *           .setSettings(AccessApprovalSettings.newBuilder().build())
+   *           .setUpdateMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   AccessApprovalSettings response =
+   *       accessApprovalAdminClient.updateAccessApprovalSettings(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 */ @@ -403,6 +610,20 @@ public final AccessApprovalSettings updateAccessApprovalSettings( * determined by the value of field_mask. * *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   UpdateAccessApprovalSettingsMessage request =
+   *       UpdateAccessApprovalSettingsMessage.newBuilder()
+   *           .setSettings(AccessApprovalSettings.newBuilder().build())
+   *           .setUpdateMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   ApiFuture future =
+   *       accessApprovalAdminClient.updateAccessApprovalSettingsCallable().futureCall(request);
+   *   // Do something.
+   *   AccessApprovalSettings response = future.get();
+   * }
+   * }
*/ public final UnaryCallable updateAccessApprovalSettingsCallable() { @@ -417,6 +638,15 @@ public final AccessApprovalSettings updateAccessApprovalSettings( * of the hierarchy, then Access Approval will still be enabled at this level as the settings are * inherited. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   String name = "name3373707";
+   *   accessApprovalAdminClient.deleteAccessApprovalSettings(name);
+   * }
+   * }
+ * * @param name Name of the AccessApprovalSettings to delete. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -434,6 +664,16 @@ public final void deleteAccessApprovalSettings(String name) { * of the hierarchy, then Access Approval will still be enabled at this level as the settings are * inherited. * + *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   DeleteAccessApprovalSettingsMessage request =
+   *       DeleteAccessApprovalSettingsMessage.newBuilder().setName("name3373707").build();
+   *   accessApprovalAdminClient.deleteAccessApprovalSettings(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 */ @@ -450,6 +690,17 @@ public final void deleteAccessApprovalSettings(DeleteAccessApprovalSettingsMessa * inherited. * *

Sample code: + * + *

{@code
+   * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+   *   DeleteAccessApprovalSettingsMessage request =
+   *       DeleteAccessApprovalSettingsMessage.newBuilder().setName("name3373707").build();
+   *   ApiFuture future =
+   *       accessApprovalAdminClient.deleteAccessApprovalSettingsCallable().futureCall(request);
+   *   // Do something.
+   *   future.get();
+   * }
+   * }
*/ public final UnaryCallable deleteAccessApprovalSettingsCallable() { diff --git a/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/package-info.java b/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/package-info.java index c9cc0ee5..debdb475 100644 --- a/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/package-info.java +++ b/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/package-info.java @@ -49,6 +49,13 @@ *

If a request is not approved or dismissed, we call it pending. * *

Sample for AccessApprovalAdminClient: + * + *

{@code
+ * try (AccessApprovalAdminClient accessApprovalAdminClient = AccessApprovalAdminClient.create()) {
+ *   String name = "name3373707";
+ *   ApprovalRequest response = accessApprovalAdminClient.getApprovalRequest(name);
+ * }
+ * }
*/ @Generated("by gapic-generator-java") package com.google.cloud.accessapproval.v1; diff --git a/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/AccessApprovalStubSettings.java b/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/AccessApprovalStubSettings.java index 8924c733..0245cb90 100644 --- a/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/AccessApprovalStubSettings.java +++ b/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/AccessApprovalStubSettings.java @@ -79,18 +79,19 @@ *

For example, to set the total timeout of getApprovalRequest to 30 seconds: * *

{@code
- * AccessApprovalStubSettings.Builder accessApprovalSettingsBuilder =
+ * AccessApprovalStubSettings.Builder accessApprovalAdminSettingsBuilder =
  *     AccessApprovalStubSettings.newBuilder();
- * accessApprovalSettingsBuilder
+ * accessApprovalAdminSettingsBuilder
  *     .getApprovalRequestSettings()
  *     .setRetrySettings(
- *         accessApprovalSettingsBuilder
+ *         accessApprovalAdminSettingsBuilder
  *             .getApprovalRequestSettings()
  *             .getRetrySettings()
  *             .toBuilder()
  *             .setTotalTimeout(Duration.ofSeconds(30))
  *             .build());
- * AccessApprovalStubSettings accessApprovalSettings = accessApprovalSettingsBuilder.build();
+ * AccessApprovalStubSettings accessApprovalAdminSettings =
+ *     accessApprovalAdminSettingsBuilder.build();
  * }
*/ @Generated("by gapic-generator-java") diff --git a/synth.metadata b/synth.metadata index 04413026..07166827 100644 --- a/synth.metadata +++ b/synth.metadata @@ -4,15 +4,15 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/java-accessapproval.git", - "sha": "7dbe801fe9aa9b8e6719cffe72820410cf1268a9" + "sha": "d67e613317b198630c83b295f5cefb1b017853d2" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "91e206bcfeaf8948ea03fe3cb1b7616108496cd3", - "internalRef": "350949863" + "sha": "8d8c008e56f1af31d57f75561e0f1848ffb29eeb", + "internalRef": "356341083" } }, {