• Home
• com.google.cloud
• google-cloud-cloudsupport
• 0.4.0
• source code
• CaseAttachmentServiceClient.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.support.v2.CaseAttachmentServiceClient Maven / Gradle / Ivy

/*
 * Copyright 2023 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.support.v2;

import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
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.support.v2.stub.CaseAttachmentServiceStub;
import com.google.cloud.support.v2.stub.CaseAttachmentServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
 * Service Description: A service to manage file attachment for Google Cloud support cases.
 *
 * 
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
 * // This snippet has been automatically generated and should be regarded as a code template only.
 * // It will require modifications to work:
 * // - It may require correct/in-range values for request initialization.
 * // - It may require specifying regional endpoints when creating the service client as shown in
 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 * try (CaseAttachmentServiceClient caseAttachmentServiceClient =
 *     CaseAttachmentServiceClient.create()) {
 *   CaseName parent = CaseName.ofProjectCaseName("[PROJECT]", "[CASE]");
 *   for (Attachment element : caseAttachmentServiceClient.listAttachments(parent).iterateAll()) {
 *     // doThingsWith(element);
 *   }
 * }
 * }
 *
 * 
Note: close() needs to be called on the CaseAttachmentServiceClient object to clean up
 * resources such as threads. In the example above, try-with-resources is used, which automatically
 * calls close().
 *
 * 
The surface of this class includes several types of Java methods for each of the API's
 * methods:
 *
 * 

 *   
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.
 *   
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.
 *   
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.
 * 
 *
 * 
See the individual methods for example code.
 *
 * 
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.
 *
 * 
This class can be customized by passing in a custom instance of CaseAttachmentServiceSettings
 * to create(). For example:
 *
 * 
To customize credentials:
 *
 * 
{@code
 * // This snippet has been automatically generated and should be regarded as a code template only.
 * // It will require modifications to work:
 * // - It may require correct/in-range values for request initialization.
 * // - It may require specifying regional endpoints when creating the service client as shown in
 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 * CaseAttachmentServiceSettings caseAttachmentServiceSettings =
 *     CaseAttachmentServiceSettings.newBuilder()
 *         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
 *         .build();
 * CaseAttachmentServiceClient caseAttachmentServiceClient =
 *     CaseAttachmentServiceClient.create(caseAttachmentServiceSettings);
 * }
 *
 * 
To customize the endpoint:
 *
 * 
{@code
 * // This snippet has been automatically generated and should be regarded as a code template only.
 * // It will require modifications to work:
 * // - It may require correct/in-range values for request initialization.
 * // - It may require specifying regional endpoints when creating the service client as shown in
 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 * CaseAttachmentServiceSettings caseAttachmentServiceSettings =
 *     CaseAttachmentServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 * CaseAttachmentServiceClient caseAttachmentServiceClient =
 *     CaseAttachmentServiceClient.create(caseAttachmentServiceSettings);
 * }
 *
 * 
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
 * the wire:
 *
 * 
{@code
 * // This snippet has been automatically generated and should be regarded as a code template only.
 * // It will require modifications to work:
 * // - It may require correct/in-range values for request initialization.
 * // - It may require specifying regional endpoints when creating the service client as shown in
 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 * CaseAttachmentServiceSettings caseAttachmentServiceSettings =
 *     CaseAttachmentServiceSettings.newHttpJsonBuilder().build();
 * CaseAttachmentServiceClient caseAttachmentServiceClient =
 *     CaseAttachmentServiceClient.create(caseAttachmentServiceSettings);
 * }
 *
 * 
Please refer to the GitHub repository's samples for more quickstart code snippets.
 */
@Generated("by gapic-generator-java")
public class CaseAttachmentServiceClient implements BackgroundResource {
  private final CaseAttachmentServiceSettings settings;
  private final CaseAttachmentServiceStub stub;

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

  /**
   * Constructs an instance of CaseAttachmentServiceClient, 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 CaseAttachmentServiceClient create(CaseAttachmentServiceSettings settings)
      throws IOException {
    return new CaseAttachmentServiceClient(settings);
  }

  /**
   * Constructs an instance of CaseAttachmentServiceClient, using the given stub for making calls.
   * This is for advanced usage - prefer using create(CaseAttachmentServiceSettings).
   */
  public static final CaseAttachmentServiceClient create(CaseAttachmentServiceStub stub) {
    return new CaseAttachmentServiceClient(stub);
  }

  /**
   * Constructs an instance of CaseAttachmentServiceClient, 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 CaseAttachmentServiceClient(CaseAttachmentServiceSettings settings) throws IOException {
    this.settings = settings;
    this.stub = ((CaseAttachmentServiceStubSettings) settings.getStubSettings()).createStub();
  }

  protected CaseAttachmentServiceClient(CaseAttachmentServiceStub stub) {
    this.settings = null;
    this.stub = stub;
  }

  public final CaseAttachmentServiceSettings getSettings() {
    return settings;
  }

  public CaseAttachmentServiceStub getStub() {
    return stub;
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Retrieve all attachments associated with a support case.
   *
   * 
Sample code:
   *
   * 
{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (CaseAttachmentServiceClient caseAttachmentServiceClient =
   *     CaseAttachmentServiceClient.create()) {
   *   CaseName parent = CaseName.ofProjectCaseName("[PROJECT]", "[CASE]");
   *   for (Attachment element : caseAttachmentServiceClient.listAttachments(parent).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   *
   * @param parent Required. The resource name of Case object for which attachments should be
   *     listed.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final ListAttachmentsPagedResponse listAttachments(CaseName parent) {
    ListAttachmentsRequest request =
        ListAttachmentsRequest.newBuilder()
            .setParent(parent == null ? null : parent.toString())
            .build();
    return listAttachments(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Retrieve all attachments associated with a support case.
   *
   * 
Sample code:
   *
   * 
{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (CaseAttachmentServiceClient caseAttachmentServiceClient =
   *     CaseAttachmentServiceClient.create()) {
   *   String parent = CaseName.ofOrganizationCaseName("[ORGANIZATION]", "[CASE]").toString();
   *   for (Attachment element : caseAttachmentServiceClient.listAttachments(parent).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   *
   * @param parent Required. The resource name of Case object for which attachments should be
   *     listed.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final ListAttachmentsPagedResponse listAttachments(String parent) {
    ListAttachmentsRequest request = ListAttachmentsRequest.newBuilder().setParent(parent).build();
    return listAttachments(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Retrieve all attachments associated with a support case.
   *
   * 
Sample code:
   *
   * 
{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (CaseAttachmentServiceClient caseAttachmentServiceClient =
   *     CaseAttachmentServiceClient.create()) {
   *   ListAttachmentsRequest request =
   *       ListAttachmentsRequest.newBuilder()
   *           .setParent(CaseName.ofProjectCaseName("[PROJECT]", "[CASE]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   for (Attachment element : caseAttachmentServiceClient.listAttachments(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
   */
  public final ListAttachmentsPagedResponse listAttachments(ListAttachmentsRequest request) {
    return listAttachmentsPagedCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Retrieve all attachments associated with a support case.
   *
   * 
Sample code:
   *
   * 
{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (CaseAttachmentServiceClient caseAttachmentServiceClient =
   *     CaseAttachmentServiceClient.create()) {
   *   ListAttachmentsRequest request =
   *       ListAttachmentsRequest.newBuilder()
   *           .setParent(CaseName.ofProjectCaseName("[PROJECT]", "[CASE]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   ApiFuture future =
   *       caseAttachmentServiceClient.listAttachmentsPagedCallable().futureCall(request);
   *   // Do something.
   *   for (Attachment element : future.get().iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   */
  public final UnaryCallable
      listAttachmentsPagedCallable() {
    return stub.listAttachmentsPagedCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Retrieve all attachments associated with a support case.
   *
   * 
Sample code:
   *
   * 
{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (CaseAttachmentServiceClient caseAttachmentServiceClient =
   *     CaseAttachmentServiceClient.create()) {
   *   ListAttachmentsRequest request =
   *       ListAttachmentsRequest.newBuilder()
   *           .setParent(CaseName.ofProjectCaseName("[PROJECT]", "[CASE]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   while (true) {
   *     ListAttachmentsResponse response =
   *         caseAttachmentServiceClient.listAttachmentsCallable().call(request);
   *     for (Attachment element : response.getAttachmentsList()) {
   *       // doThingsWith(element);
   *     }
   *     String nextPageToken = response.getNextPageToken();
   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
   *       request = request.toBuilder().setPageToken(nextPageToken).build();
   *     } else {
   *       break;
   *     }
   *   }
   * }
   * }
   */
  public final UnaryCallable
      listAttachmentsCallable() {
    return stub.listAttachmentsCallable();
  }

  @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 ListAttachmentsPagedResponse
      extends AbstractPagedListResponse<
          ListAttachmentsRequest,
          ListAttachmentsResponse,
          Attachment,
          ListAttachmentsPage,
          ListAttachmentsFixedSizeCollection> {

    public static ApiFuture createAsync(
        PageContext context,
        ApiFuture futureResponse) {
      ApiFuture futurePage =
          ListAttachmentsPage.createEmptyPage().createPageAsync(context, futureResponse);
      return ApiFutures.transform(
          futurePage,
          input -> new ListAttachmentsPagedResponse(input),
          MoreExecutors.directExecutor());
    }

    private ListAttachmentsPagedResponse(ListAttachmentsPage page) {
      super(page, ListAttachmentsFixedSizeCollection.createEmptyCollection());
    }
  }

  public static class ListAttachmentsPage
      extends AbstractPage<
          ListAttachmentsRequest, ListAttachmentsResponse, Attachment, ListAttachmentsPage> {

    private ListAttachmentsPage(
        PageContext context,
        ListAttachmentsResponse response) {
      super(context, response);
    }

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

    @Override
    protected ListAttachmentsPage createPage(
        PageContext context,
        ListAttachmentsResponse response) {
      return new ListAttachmentsPage(context, response);
    }

    @Override
    public ApiFuture createPageAsync(
        PageContext context,
        ApiFuture futureResponse) {
      return super.createPageAsync(context, futureResponse);
    }
  }

  public static class ListAttachmentsFixedSizeCollection
      extends AbstractFixedSizeCollection<
          ListAttachmentsRequest,
          ListAttachmentsResponse,
          Attachment,
          ListAttachmentsPage,
          ListAttachmentsFixedSizeCollection> {

    private ListAttachmentsFixedSizeCollection(
        List pages, int collectionSize) {
      super(pages, collectionSize);
    }

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

    @Override
    protected ListAttachmentsFixedSizeCollection createCollection(
        List pages, int collectionSize) {
      return new ListAttachmentsFixedSizeCollection(pages, collectionSize);
    }
  }
}