com.google.shopping.merchant.accounts.v1beta.AccountIssueServiceClient Maven / Gradle / Ivy
Show all versions of google-shopping-merchant-accounts Show documentation
/*
* Copyright 2024 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.shopping.merchant.accounts.v1beta;
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.common.util.concurrent.MoreExecutors;
import com.google.shopping.merchant.accounts.v1beta.stub.AccountIssueServiceStub;
import com.google.shopping.merchant.accounts.v1beta.stub.AccountIssueServiceStubSettings;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service to support `AccountIssueService` API.
*
* 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
* AccountName parent = AccountName.of("[ACCOUNT]");
* for (AccountIssue element :
* accountIssueServiceClient.listAccountIssues(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* Note: close() needs to be called on the AccountIssueServiceClient object to clean up resources
* such as threads. In the example above, try-with-resources is used, which automatically calls
* close().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* ListAccountIssues
Lists all account issues of a Merchant Center account.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listAccountIssues(ListAccountIssuesRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listAccountIssues(AccountName parent)
*
listAccountIssues(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listAccountIssuesPagedCallable()
*
listAccountIssuesCallable()
*
*
*
*
*
* 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 AccountIssueServiceSettings 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
* AccountIssueServiceSettings accountIssueServiceSettings =
* AccountIssueServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* AccountIssueServiceClient accountIssueServiceClient =
* AccountIssueServiceClient.create(accountIssueServiceSettings);
* }
*
* 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
* AccountIssueServiceSettings accountIssueServiceSettings =
* AccountIssueServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* AccountIssueServiceClient accountIssueServiceClient =
* AccountIssueServiceClient.create(accountIssueServiceSettings);
* }
*
* 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
* AccountIssueServiceSettings accountIssueServiceSettings =
* AccountIssueServiceSettings.newHttpJsonBuilder().build();
* AccountIssueServiceClient accountIssueServiceClient =
* AccountIssueServiceClient.create(accountIssueServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class AccountIssueServiceClient implements BackgroundResource {
private final AccountIssueServiceSettings settings;
private final AccountIssueServiceStub stub;
/** Constructs an instance of AccountIssueServiceClient with default settings. */
public static final AccountIssueServiceClient create() throws IOException {
return create(AccountIssueServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of AccountIssueServiceClient, 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 AccountIssueServiceClient create(AccountIssueServiceSettings settings)
throws IOException {
return new AccountIssueServiceClient(settings);
}
/**
* Constructs an instance of AccountIssueServiceClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(AccountIssueServiceSettings).
*/
public static final AccountIssueServiceClient create(AccountIssueServiceStub stub) {
return new AccountIssueServiceClient(stub);
}
/**
* Constructs an instance of AccountIssueServiceClient, 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 AccountIssueServiceClient(AccountIssueServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((AccountIssueServiceStubSettings) settings.getStubSettings()).createStub();
}
protected AccountIssueServiceClient(AccountIssueServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final AccountIssueServiceSettings getSettings() {
return settings;
}
public AccountIssueServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all account issues of a Merchant Center account.
*
*
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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
* AccountName parent = AccountName.of("[ACCOUNT]");
* for (AccountIssue element :
* accountIssueServiceClient.listAccountIssues(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent, which owns this collection of issues. Format:
* `accounts/{account}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAccountIssuesPagedResponse listAccountIssues(AccountName parent) {
ListAccountIssuesRequest request =
ListAccountIssuesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listAccountIssues(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all account issues of a Merchant Center account.
*
* 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
* String parent = AccountName.of("[ACCOUNT]").toString();
* for (AccountIssue element :
* accountIssueServiceClient.listAccountIssues(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent, which owns this collection of issues. Format:
* `accounts/{account}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAccountIssuesPagedResponse listAccountIssues(String parent) {
ListAccountIssuesRequest request =
ListAccountIssuesRequest.newBuilder().setParent(parent).build();
return listAccountIssues(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all account issues of a Merchant Center account.
*
* 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
* ListAccountIssuesRequest request =
* ListAccountIssuesRequest.newBuilder()
* .setParent(AccountName.of("[ACCOUNT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setLanguageCode("languageCode-2092349083")
* .setTimeZone(TimeZone.newBuilder().build())
* .build();
* for (AccountIssue element :
* accountIssueServiceClient.listAccountIssues(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 ListAccountIssuesPagedResponse listAccountIssues(ListAccountIssuesRequest request) {
return listAccountIssuesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all account issues of a Merchant Center account.
*
* 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
* ListAccountIssuesRequest request =
* ListAccountIssuesRequest.newBuilder()
* .setParent(AccountName.of("[ACCOUNT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setLanguageCode("languageCode-2092349083")
* .setTimeZone(TimeZone.newBuilder().build())
* .build();
* ApiFuture future =
* accountIssueServiceClient.listAccountIssuesPagedCallable().futureCall(request);
* // Do something.
* for (AccountIssue element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listAccountIssuesPagedCallable() {
return stub.listAccountIssuesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all account issues of a Merchant Center account.
*
* 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
* ListAccountIssuesRequest request =
* ListAccountIssuesRequest.newBuilder()
* .setParent(AccountName.of("[ACCOUNT]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setLanguageCode("languageCode-2092349083")
* .setTimeZone(TimeZone.newBuilder().build())
* .build();
* while (true) {
* ListAccountIssuesResponse response =
* accountIssueServiceClient.listAccountIssuesCallable().call(request);
* for (AccountIssue element : response.getAccountIssuesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listAccountIssuesCallable() {
return stub.listAccountIssuesCallable();
}
@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 ListAccountIssuesPagedResponse
extends AbstractPagedListResponse<
ListAccountIssuesRequest,
ListAccountIssuesResponse,
AccountIssue,
ListAccountIssuesPage,
ListAccountIssuesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListAccountIssuesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListAccountIssuesPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListAccountIssuesPagedResponse(ListAccountIssuesPage page) {
super(page, ListAccountIssuesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListAccountIssuesPage
extends AbstractPage<
ListAccountIssuesRequest,
ListAccountIssuesResponse,
AccountIssue,
ListAccountIssuesPage> {
private ListAccountIssuesPage(
PageContext context,
ListAccountIssuesResponse response) {
super(context, response);
}
private static ListAccountIssuesPage createEmptyPage() {
return new ListAccountIssuesPage(null, null);
}
@Override
protected ListAccountIssuesPage createPage(
PageContext context,
ListAccountIssuesResponse response) {
return new ListAccountIssuesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListAccountIssuesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListAccountIssuesRequest,
ListAccountIssuesResponse,
AccountIssue,
ListAccountIssuesPage,
ListAccountIssuesFixedSizeCollection> {
private ListAccountIssuesFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListAccountIssuesFixedSizeCollection createEmptyCollection() {
return new ListAccountIssuesFixedSizeCollection(null, 0);
}
@Override
protected ListAccountIssuesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListAccountIssuesFixedSizeCollection(pages, collectionSize);
}
}
}