Class TargetGrpcProxiesClient (1.45.0)

Version 1.45.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

GitHub Repository

Product Reference

Service Description: The TargetGrpcProxies 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:

 // 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   String project = "project-309310695";
   String targetGrpcProxy = "targetGrpcProxy1045500511";
   TargetGrpcProxy response = targetGrpcProxiesClient.get(project, targetGrpcProxy);
 }
 

Note: close() needs to be called on the TargetGrpcProxiesClient 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
Delete	Deletes the specified TargetGrpcProxy in the given scope	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteTargetGrpcProxyRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. deleteAsync(String project, String targetGrpcProxy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteOperationCallable() deleteCallable()
Get	Returns the specified TargetGrpcProxy resource in the given scope.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetTargetGrpcProxyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String targetGrpcProxy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
Insert	Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertTargetGrpcProxyRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. insertAsync(String project, TargetGrpcProxy targetGrpcProxyResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. insertOperationCallable() insertCallable()
List	Lists the TargetGrpcProxies for a project in the given scope.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListTargetGrpcProxiesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()
Patch	Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.	Request object method variants only take one parameter, a request object, which must be constructed before the call. patchAsync(PatchTargetGrpcProxyRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. patchAsync(String project, String targetGrpcProxy, TargetGrpcProxy targetGrpcProxyResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. patchOperationCallable() patchCallable()

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 TargetGrpcProxiesSettings to create(). For example:

To customize credentials:

 // 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
 TargetGrpcProxiesSettings targetGrpcProxiesSettings =
     TargetGrpcProxiesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TargetGrpcProxiesClient targetGrpcProxiesClient =
     TargetGrpcProxiesClient.create(targetGrpcProxiesSettings);
 

To customize the endpoint:

 // 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
 TargetGrpcProxiesSettings targetGrpcProxiesSettings =
     TargetGrpcProxiesSettings.newBuilder().setEndpoint(myEndpoint).build();
 TargetGrpcProxiesClient targetGrpcProxiesClient =
     TargetGrpcProxiesClient.create(targetGrpcProxiesSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > TargetGrpcProxiesClient

Static Methods

create()

public static final TargetGrpcProxiesClient create()

Constructs an instance of TargetGrpcProxiesClient with default settings.

Returns
Type	Description
TargetGrpcProxiesClient

Exceptions
Type	Description
IOException

create(TargetGrpcProxiesSettings settings)

public static final TargetGrpcProxiesClient create(TargetGrpcProxiesSettings settings)

Constructs an instance of TargetGrpcProxiesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
settings	TargetGrpcProxiesSettings

Returns
Type	Description
TargetGrpcProxiesClient

Exceptions
Type	Description
IOException

create(TargetGrpcProxiesStub stub)

public static final TargetGrpcProxiesClient create(TargetGrpcProxiesStub stub)

Constructs an instance of TargetGrpcProxiesClient, using the given stub for making calls. This is for advanced usage - prefer using create(TargetGrpcProxiesSettings).

Parameter
Name	Description
stub	TargetGrpcProxiesStub

Returns
Type	Description
TargetGrpcProxiesClient

Constructors

TargetGrpcProxiesClient(TargetGrpcProxiesSettings settings)

protected TargetGrpcProxiesClient(TargetGrpcProxiesSettings settings)

Constructs an instance of TargetGrpcProxiesClient, 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.

Parameter
Name	Description
settings	TargetGrpcProxiesSettings

TargetGrpcProxiesClient(TargetGrpcProxiesStub stub)

protected TargetGrpcProxiesClient(TargetGrpcProxiesStub stub)

Parameter
Name	Description
stub	TargetGrpcProxiesStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

close()

public final void close()

deleteAsync(DeleteTargetGrpcProxyRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteTargetGrpcProxyRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Deletes the specified TargetGrpcProxy in the given scope

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   DeleteTargetGrpcProxyRequest request =
       DeleteTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetGrpcProxy("targetGrpcProxy1045500511")
           .build();
   Operation response = targetGrpcProxiesClient.deleteAsync(request).get();
 }
 

Parameter
Name	Description
request	DeleteTargetGrpcProxyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String targetGrpcProxy)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String targetGrpcProxy)

Deletes the specified TargetGrpcProxy in the given scope

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   String project = "project-309310695";
   String targetGrpcProxy = "targetGrpcProxy1045500511";
   Operation response = targetGrpcProxiesClient.deleteAsync(project, targetGrpcProxy).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
targetGrpcProxy	String Name of the TargetGrpcProxy resource to delete.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteTargetGrpcProxyRequest,Operation> deleteCallable()

Deletes the specified TargetGrpcProxy in the given scope

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   DeleteTargetGrpcProxyRequest request =
       DeleteTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetGrpcProxy("targetGrpcProxy1045500511")
           .build();
   ApiFuture<Operation> future = targetGrpcProxiesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteTargetGrpcProxyRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteTargetGrpcProxyRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified TargetGrpcProxy in the given scope

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   DeleteTargetGrpcProxyRequest request =
       DeleteTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetGrpcProxy("targetGrpcProxy1045500511")
           .build();
   OperationFuture<Operation, Operation> future =
       targetGrpcProxiesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteTargetGrpcProxyRequest,Operation,Operation>

get(GetTargetGrpcProxyRequest request)

public final TargetGrpcProxy get(GetTargetGrpcProxyRequest request)

Returns the specified TargetGrpcProxy resource in the given scope.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   GetTargetGrpcProxyRequest request =
       GetTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setTargetGrpcProxy("targetGrpcProxy1045500511")
           .build();
   TargetGrpcProxy response = targetGrpcProxiesClient.get(request);
 }
 

Parameter
Name	Description
request	GetTargetGrpcProxyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
TargetGrpcProxy

get(String project, String targetGrpcProxy)

public final TargetGrpcProxy get(String project, String targetGrpcProxy)

Returns the specified TargetGrpcProxy resource in the given scope.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   String project = "project-309310695";
   String targetGrpcProxy = "targetGrpcProxy1045500511";
   TargetGrpcProxy response = targetGrpcProxiesClient.get(project, targetGrpcProxy);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
targetGrpcProxy	String Name of the TargetGrpcProxy resource to return.

Returns
Type	Description
TargetGrpcProxy

getCallable()

public final UnaryCallable<GetTargetGrpcProxyRequest,TargetGrpcProxy> getCallable()

Returns the specified TargetGrpcProxy resource in the given scope.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   GetTargetGrpcProxyRequest request =
       GetTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setTargetGrpcProxy("targetGrpcProxy1045500511")
           .build();
   ApiFuture<TargetGrpcProxy> future = targetGrpcProxiesClient.getCallable().futureCall(request);
   // Do something.
   TargetGrpcProxy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetTargetGrpcProxyRequest,TargetGrpcProxy>

getSettings()

public final TargetGrpcProxiesSettings getSettings()

Returns
Type	Description
TargetGrpcProxiesSettings

getStub()

public TargetGrpcProxiesStub getStub()

Returns
Type	Description
TargetGrpcProxiesStub

insertAsync(InsertTargetGrpcProxyRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertTargetGrpcProxyRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   InsertTargetGrpcProxyRequest request =
       InsertTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetGrpcProxyResource(TargetGrpcProxy.newBuilder().build())
           .build();
   Operation response = targetGrpcProxiesClient.insertAsync(request).get();
 }
 

Parameter
Name	Description
request	InsertTargetGrpcProxyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, TargetGrpcProxy targetGrpcProxyResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, TargetGrpcProxy targetGrpcProxyResource)

Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   String project = "project-309310695";
   TargetGrpcProxy targetGrpcProxyResource = TargetGrpcProxy.newBuilder().build();
   Operation response =
       targetGrpcProxiesClient.insertAsync(project, targetGrpcProxyResource).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
targetGrpcProxyResource	TargetGrpcProxy The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertTargetGrpcProxyRequest,Operation> insertCallable()

Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   InsertTargetGrpcProxyRequest request =
       InsertTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetGrpcProxyResource(TargetGrpcProxy.newBuilder().build())
           .build();
   ApiFuture<Operation> future = targetGrpcProxiesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<InsertTargetGrpcProxyRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertTargetGrpcProxyRequest,Operation,Operation> insertOperationCallable()

Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   InsertTargetGrpcProxyRequest request =
       InsertTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetGrpcProxyResource(TargetGrpcProxy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       targetGrpcProxiesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<InsertTargetGrpcProxyRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListTargetGrpcProxiesRequest request)

public final TargetGrpcProxiesClient.ListPagedResponse list(ListTargetGrpcProxiesRequest request)

Lists the TargetGrpcProxies for a project in the given scope.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   ListTargetGrpcProxiesRequest request =
       ListTargetGrpcProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (TargetGrpcProxy element : targetGrpcProxiesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
request	ListTargetGrpcProxiesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
TargetGrpcProxiesClient.ListPagedResponse

list(String project)

public final TargetGrpcProxiesClient.ListPagedResponse list(String project)

Lists the TargetGrpcProxies for a project in the given scope.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   String project = "project-309310695";
   for (TargetGrpcProxy element : targetGrpcProxiesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
project	String Project ID for this request.

Returns
Type	Description
TargetGrpcProxiesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListTargetGrpcProxiesRequest,TargetGrpcProxyList> listCallable()

Lists the TargetGrpcProxies for a project in the given scope.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   ListTargetGrpcProxiesRequest request =
       ListTargetGrpcProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     TargetGrpcProxyList response = targetGrpcProxiesClient.listCallable().call(request);
     for (TargetGrpcProxy element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListTargetGrpcProxiesRequest,TargetGrpcProxyList>

listPagedCallable()

public final UnaryCallable<ListTargetGrpcProxiesRequest,TargetGrpcProxiesClient.ListPagedResponse> listPagedCallable()

Lists the TargetGrpcProxies for a project in the given scope.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   ListTargetGrpcProxiesRequest request =
       ListTargetGrpcProxiesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<TargetGrpcProxy> future =
       targetGrpcProxiesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (TargetGrpcProxy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListTargetGrpcProxiesRequest,ListPagedResponse>

patchAsync(PatchTargetGrpcProxyRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchTargetGrpcProxyRequest request)

Beta

The surface for long-running operations is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   PatchTargetGrpcProxyRequest request =
       PatchTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetGrpcProxy("targetGrpcProxy1045500511")
           .setTargetGrpcProxyResource(TargetGrpcProxy.newBuilder().build())
           .build();
   Operation response = targetGrpcProxiesClient.patchAsync(request).get();
 }
 

Parameter
Name	Description
request	PatchTargetGrpcProxyRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String targetGrpcProxy, TargetGrpcProxy targetGrpcProxyResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String targetGrpcProxy, TargetGrpcProxy targetGrpcProxyResource)

Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   String project = "project-309310695";
   String targetGrpcProxy = "targetGrpcProxy1045500511";
   TargetGrpcProxy targetGrpcProxyResource = TargetGrpcProxy.newBuilder().build();
   Operation response =
       targetGrpcProxiesClient
           .patchAsync(project, targetGrpcProxy, targetGrpcProxyResource)
           .get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
targetGrpcProxy	String Name of the TargetGrpcProxy resource to patch.
targetGrpcProxyResource	TargetGrpcProxy The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchTargetGrpcProxyRequest,Operation> patchCallable()

Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   PatchTargetGrpcProxyRequest request =
       PatchTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetGrpcProxy("targetGrpcProxy1045500511")
           .setTargetGrpcProxyResource(TargetGrpcProxy.newBuilder().build())
           .build();
   ApiFuture<Operation> future = targetGrpcProxiesClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<PatchTargetGrpcProxyRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchTargetGrpcProxyRequest,Operation,Operation> patchOperationCallable()

Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Sample 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 (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
   PatchTargetGrpcProxyRequest request =
       PatchTargetGrpcProxyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setTargetGrpcProxy("targetGrpcProxy1045500511")
           .setTargetGrpcProxyResource(TargetGrpcProxy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       targetGrpcProxiesClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<PatchTargetGrpcProxyRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()