DashboardsServiceClient.java

/*
 * Copyright 2021 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud.monitoring.dashboard.v1;

import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.monitoring.dashboard.v1.stub.DashboardsServiceStub;
import com.google.cloud.monitoring.dashboard.v1.stub.DashboardsServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.monitoring.dashboard.v1.CreateDashboardRequest;
import com.google.monitoring.dashboard.v1.Dashboard;
import com.google.monitoring.dashboard.v1.DeleteDashboardRequest;
import com.google.monitoring.dashboard.v1.GetDashboardRequest;
import com.google.monitoring.dashboard.v1.ListDashboardsRequest;
import com.google.monitoring.dashboard.v1.ListDashboardsResponse;
import com.google.monitoring.dashboard.v1.UpdateDashboardRequest;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
 * Service Description: Manages Stackdriver dashboards. A dashboard is an arrangement of data
 * display widgets in a specific layout.
 *
 * <p>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:
 *
 * <pre>{@code
 * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
 *   CreateDashboardRequest request =
 *       CreateDashboardRequest.newBuilder()
 *           .setParent("parent-995424086")
 *           .setDashboard(Dashboard.newBuilder().build())
 *           .setValidateOnly(true)
 *           .build();
 *   Dashboard response = dashboardsServiceClient.createDashboard(request);
 * }
 * }</pre>
 *
 * <p>Note: close() needs to be called on the DashboardsServiceClient object to clean up resources
 * such as threads. In the example above, try-with-resources is used, which automatically calls
 * close().
 *
 * <p>The surface of this class includes several types of Java methods for each of the API's
 * methods:
 *
 * <ol>
 *   <li>A "flattened" method. With this type of method, the fields of the request type have been
 *       converted into function parameters. It may be the case that not all fields are available as
 *       parameters, and not every API method will have a flattened method entry point.
 *   <li>A "request object" method. This type of method only takes one parameter, a request object,
 *       which must be constructed before the call. Not every API method will have a request object
 *       method.
 *   <li>A "callable" method. This type of method takes no parameters and returns an immutable API
 *       callable object, which can be used to initiate calls to the service.
 * </ol>
 *
 * <p>See the individual methods for example code.
 *
 * <p>Many parameters require resource names to be formatted in a particular way. To assist with
 * these names, this class includes a format method for each type of name, and additionally a parse
 * method to extract the individual identifiers contained within names that are returned.
 *
 * <p>This class can be customized by passing in a custom instance of DashboardsServiceSettings to
 * create(). For example:
 *
 * <p>To customize credentials:
 *
 * <pre>{@code
 * DashboardsServiceSettings dashboardsServiceSettings =
 *     DashboardsServiceSettings.newBuilder()
 *         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
 *         .build();
 * DashboardsServiceClient dashboardsServiceClient =
 *     DashboardsServiceClient.create(dashboardsServiceSettings);
 * }</pre>
 *
 * <p>To customize the endpoint:
 *
 * <pre>{@code
 * DashboardsServiceSettings dashboardsServiceSettings =
 *     DashboardsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 * DashboardsServiceClient dashboardsServiceClient =
 *     DashboardsServiceClient.create(dashboardsServiceSettings);
 * }</pre>
 *
 * <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
 */
@Generated("by gapic-generator-java")
public class DashboardsServiceClient implements BackgroundResource {
  private final DashboardsServiceSettings settings;
  private final DashboardsServiceStub stub;

  /** Constructs an instance of DashboardsServiceClient with default settings. */
  public static final DashboardsServiceClient create() throws IOException {
    return create(DashboardsServiceSettings.newBuilder().build());
  }

  /**
   * Constructs an instance of DashboardsServiceClient, using the given settings. The channels are
   * created based on the settings passed in, or defaults for any settings that are not set.
   */
  public static final DashboardsServiceClient create(DashboardsServiceSettings settings)
      throws IOException {
    return new DashboardsServiceClient(settings);
  }

  /**
   * Constructs an instance of DashboardsServiceClient, using the given stub for making calls. This
   * is for advanced usage - prefer using create(DashboardsServiceSettings).
   */
  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
  public static final DashboardsServiceClient create(DashboardsServiceStub stub) {
    return new DashboardsServiceClient(stub);
  }

  /**
   * Constructs an instance of DashboardsServiceClient, using the given settings. This is protected
   * so that it is easy to make a subclass, but otherwise, the static factory methods should be
   * preferred.
   */
  protected DashboardsServiceClient(DashboardsServiceSettings settings) throws IOException {
    this.settings = settings;
    this.stub = ((DashboardsServiceStubSettings) settings.getStubSettings()).createStub();
  }

  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
  protected DashboardsServiceClient(DashboardsServiceStub stub) {
    this.settings = null;
    this.stub = stub;
  }

  public final DashboardsServiceSettings getSettings() {
    return settings;
  }

  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
  public DashboardsServiceStub getStub() {
    return stub;
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a new custom dashboard. For examples on how you can use this API to create dashboards,
   * see [Managing dashboards by API](/monitoring/dashboards/api-dashboard). This method requires
   * the `monitoring.dashboards.create` permission on the specified project. For more information
   * about permissions, see [Cloud Identity and Access Management](/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   CreateDashboardRequest request =
   *       CreateDashboardRequest.newBuilder()
   *           .setParent("parent-995424086")
   *           .setDashboard(Dashboard.newBuilder().build())
   *           .setValidateOnly(true)
   *           .build();
   *   Dashboard response = dashboardsServiceClient.createDashboard(request);
   * }
   * }</pre>
   *
   * @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
   */
  public final Dashboard createDashboard(CreateDashboardRequest request) {
    return createDashboardCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a new custom dashboard. For examples on how you can use this API to create dashboards,
   * see [Managing dashboards by API](/monitoring/dashboards/api-dashboard). This method requires
   * the `monitoring.dashboards.create` permission on the specified project. For more information
   * about permissions, see [Cloud Identity and Access Management](/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   CreateDashboardRequest request =
   *       CreateDashboardRequest.newBuilder()
   *           .setParent("parent-995424086")
   *           .setDashboard(Dashboard.newBuilder().build())
   *           .setValidateOnly(true)
   *           .build();
   *   ApiFuture<Dashboard> future =
   *       dashboardsServiceClient.createDashboardCallable().futureCall(request);
   *   // Do something.
   *   Dashboard response = future.get();
   * }
   * }</pre>
   */
  public final UnaryCallable<CreateDashboardRequest, Dashboard> createDashboardCallable() {
    return stub.createDashboardCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists the existing dashboards.
   *
   * <p>This method requires the `monitoring.dashboards.list` permission on the specified project.
   * For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   ListDashboardsRequest request =
   *       ListDashboardsRequest.newBuilder()
   *           .setParent(ProjectName.of("[PROJECT]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   for (Dashboard element : dashboardsServiceClient.listDashboards(request).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }</pre>
   *
   * @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
   */
  public final ListDashboardsPagedResponse listDashboards(ListDashboardsRequest request) {
    return listDashboardsPagedCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists the existing dashboards.
   *
   * <p>This method requires the `monitoring.dashboards.list` permission on the specified project.
   * For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   ListDashboardsRequest request =
   *       ListDashboardsRequest.newBuilder()
   *           .setParent(ProjectName.of("[PROJECT]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   ApiFuture<Dashboard> future =
   *       dashboardsServiceClient.listDashboardsPagedCallable().futureCall(request);
   *   // Do something.
   *   for (Dashboard element : future.get().iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }</pre>
   */
  public final UnaryCallable<ListDashboardsRequest, ListDashboardsPagedResponse>
      listDashboardsPagedCallable() {
    return stub.listDashboardsPagedCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists the existing dashboards.
   *
   * <p>This method requires the `monitoring.dashboards.list` permission on the specified project.
   * For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   ListDashboardsRequest request =
   *       ListDashboardsRequest.newBuilder()
   *           .setParent(ProjectName.of("[PROJECT]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   while (true) {
   *     ListDashboardsResponse response =
   *         dashboardsServiceClient.listDashboardsCallable().call(request);
   *     for (Dashboard element : response.getResponsesList()) {
   *       // doThingsWith(element);
   *     }
   *     String nextPageToken = response.getNextPageToken();
   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
   *       request = request.toBuilder().setPageToken(nextPageToken).build();
   *     } else {
   *       break;
   *     }
   *   }
   * }
   * }</pre>
   */
  public final UnaryCallable<ListDashboardsRequest, ListDashboardsResponse>
      listDashboardsCallable() {
    return stub.listDashboardsCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Fetches a specific dashboard.
   *
   * <p>This method requires the `monitoring.dashboards.get` permission on the specified dashboard.
   * For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   GetDashboardRequest request =
   *       GetDashboardRequest.newBuilder()
   *           .setName(DashboardName.of("[PROJECT]", "[DASHBOARD]").toString())
   *           .build();
   *   Dashboard response = dashboardsServiceClient.getDashboard(request);
   * }
   * }</pre>
   *
   * @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
   */
  public final Dashboard getDashboard(GetDashboardRequest request) {
    return getDashboardCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Fetches a specific dashboard.
   *
   * <p>This method requires the `monitoring.dashboards.get` permission on the specified dashboard.
   * For more information, see [Cloud Identity and Access Management](https://cloud.google.com/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   GetDashboardRequest request =
   *       GetDashboardRequest.newBuilder()
   *           .setName(DashboardName.of("[PROJECT]", "[DASHBOARD]").toString())
   *           .build();
   *   ApiFuture<Dashboard> future =
   *       dashboardsServiceClient.getDashboardCallable().futureCall(request);
   *   // Do something.
   *   Dashboard response = future.get();
   * }
   * }</pre>
   */
  public final UnaryCallable<GetDashboardRequest, Dashboard> getDashboardCallable() {
    return stub.getDashboardCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes an existing custom dashboard.
   *
   * <p>This method requires the `monitoring.dashboards.delete` permission on the specified
   * dashboard. For more information, see [Cloud Identity and Access
   * Management](https://cloud.google.com/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   DeleteDashboardRequest request =
   *       DeleteDashboardRequest.newBuilder()
   *           .setName(DashboardName.of("[PROJECT]", "[DASHBOARD]").toString())
   *           .build();
   *   dashboardsServiceClient.deleteDashboard(request);
   * }
   * }</pre>
   *
   * @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
   */
  public final void deleteDashboard(DeleteDashboardRequest request) {
    deleteDashboardCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes an existing custom dashboard.
   *
   * <p>This method requires the `monitoring.dashboards.delete` permission on the specified
   * dashboard. For more information, see [Cloud Identity and Access
   * Management](https://cloud.google.com/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   DeleteDashboardRequest request =
   *       DeleteDashboardRequest.newBuilder()
   *           .setName(DashboardName.of("[PROJECT]", "[DASHBOARD]").toString())
   *           .build();
   *   ApiFuture<Empty> future =
   *       dashboardsServiceClient.deleteDashboardCallable().futureCall(request);
   *   // Do something.
   *   future.get();
   * }
   * }</pre>
   */
  public final UnaryCallable<DeleteDashboardRequest, Empty> deleteDashboardCallable() {
    return stub.deleteDashboardCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Replaces an existing custom dashboard with a new definition.
   *
   * <p>This method requires the `monitoring.dashboards.update` permission on the specified
   * dashboard. For more information, see [Cloud Identity and Access
   * Management](https://cloud.google.com/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   UpdateDashboardRequest request =
   *       UpdateDashboardRequest.newBuilder()
   *           .setDashboard(Dashboard.newBuilder().build())
   *           .setValidateOnly(true)
   *           .build();
   *   Dashboard response = dashboardsServiceClient.updateDashboard(request);
   * }
   * }</pre>
   *
   * @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
   */
  public final Dashboard updateDashboard(UpdateDashboardRequest request) {
    return updateDashboardCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Replaces an existing custom dashboard with a new definition.
   *
   * <p>This method requires the `monitoring.dashboards.update` permission on the specified
   * dashboard. For more information, see [Cloud Identity and Access
   * Management](https://cloud.google.com/iam).
   *
   * <p>Sample code:
   *
   * <pre>{@code
   * try (DashboardsServiceClient dashboardsServiceClient = DashboardsServiceClient.create()) {
   *   UpdateDashboardRequest request =
   *       UpdateDashboardRequest.newBuilder()
   *           .setDashboard(Dashboard.newBuilder().build())
   *           .setValidateOnly(true)
   *           .build();
   *   ApiFuture<Dashboard> future =
   *       dashboardsServiceClient.updateDashboardCallable().futureCall(request);
   *   // Do something.
   *   Dashboard response = future.get();
   * }
   * }</pre>
   */
  public final UnaryCallable<UpdateDashboardRequest, Dashboard> updateDashboardCallable() {
    return stub.updateDashboardCallable();
  }

  @Override
  public final void close() {
    stub.close();
  }

  @Override
  public void shutdown() {
    stub.shutdown();
  }

  @Override
  public boolean isShutdown() {
    return stub.isShutdown();
  }

  @Override
  public boolean isTerminated() {
    return stub.isTerminated();
  }

  @Override
  public void shutdownNow() {
    stub.shutdownNow();
  }

  @Override
  public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
    return stub.awaitTermination(duration, unit);
  }

  public static class ListDashboardsPagedResponse
      extends AbstractPagedListResponse<
          ListDashboardsRequest,
          ListDashboardsResponse,
          Dashboard,
          ListDashboardsPage,
          ListDashboardsFixedSizeCollection> {

    public static ApiFuture<ListDashboardsPagedResponse> createAsync(
        PageContext<ListDashboardsRequest, ListDashboardsResponse, Dashboard> context,
        ApiFuture<ListDashboardsResponse> futureResponse) {
      ApiFuture<ListDashboardsPage> futurePage =
          ListDashboardsPage.createEmptyPage().createPageAsync(context, futureResponse);
      return ApiFutures.transform(
          futurePage,
          new ApiFunction<ListDashboardsPage, ListDashboardsPagedResponse>() {
            @Override
            public ListDashboardsPagedResponse apply(ListDashboardsPage input) {
              return new ListDashboardsPagedResponse(input);
            }
          },
          MoreExecutors.directExecutor());
    }

    private ListDashboardsPagedResponse(ListDashboardsPage page) {
      super(page, ListDashboardsFixedSizeCollection.createEmptyCollection());
    }
  }

  public static class ListDashboardsPage
      extends AbstractPage<
          ListDashboardsRequest, ListDashboardsResponse, Dashboard, ListDashboardsPage> {

    private ListDashboardsPage(
        PageContext<ListDashboardsRequest, ListDashboardsResponse, Dashboard> context,
        ListDashboardsResponse response) {
      super(context, response);
    }

    private static ListDashboardsPage createEmptyPage() {
      return new ListDashboardsPage(null, null);
    }

    @Override
    protected ListDashboardsPage createPage(
        PageContext<ListDashboardsRequest, ListDashboardsResponse, Dashboard> context,
        ListDashboardsResponse response) {
      return new ListDashboardsPage(context, response);
    }

    @Override
    public ApiFuture<ListDashboardsPage> createPageAsync(
        PageContext<ListDashboardsRequest, ListDashboardsResponse, Dashboard> context,
        ApiFuture<ListDashboardsResponse> futureResponse) {
      return super.createPageAsync(context, futureResponse);
    }
  }

  public static class ListDashboardsFixedSizeCollection
      extends AbstractFixedSizeCollection<
          ListDashboardsRequest,
          ListDashboardsResponse,
          Dashboard,
          ListDashboardsPage,
          ListDashboardsFixedSizeCollection> {

    private ListDashboardsFixedSizeCollection(List<ListDashboardsPage> pages, int collectionSize) {
      super(pages, collectionSize);
    }

    private static ListDashboardsFixedSizeCollection createEmptyCollection() {
      return new ListDashboardsFixedSizeCollection(null, 0);
    }

    @Override
    protected ListDashboardsFixedSizeCollection createCollection(
        List<ListDashboardsPage> pages, int collectionSize) {
      return new ListDashboardsFixedSizeCollection(pages, collectionSize);
    }
  }
}