- 1.57.0 (latest)
- 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
public class TargetGrpcProxiesClient implements BackgroundResource
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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().
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 TargetGrpcProxiesSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
TargetGrpcProxiesSettings targetGrpcProxiesSettings =
TargetGrpcProxiesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
TargetGrpcProxiesClient targetGrpcProxiesClient =
TargetGrpcProxiesClient.create(targetGrpcProxiesSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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.
Implements
BackgroundResourceStatic Methods
create()
public static final TargetGrpcProxiesClient create()
Constructs an instance of TargetGrpcProxiesClient with default settings.
Type | Description |
TargetGrpcProxiesClient |
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.
Name | Description |
settings | TargetGrpcProxiesSettings |
Type | Description |
TargetGrpcProxiesClient |
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).
Name | Description |
stub | TargetGrpcProxiesStub |
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.
Name | Description |
settings | TargetGrpcProxiesSettings |
TargetGrpcProxiesClient(TargetGrpcProxiesStub stub)
protected TargetGrpcProxiesClient(TargetGrpcProxiesStub stub)
Name | Description |
stub | TargetGrpcProxiesStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
deleteAsync(DeleteTargetGrpcProxyRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteTargetGrpcProxyRequest request)
Deletes the specified TargetGrpcProxy in the given scope
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
DeleteTargetGrpcProxyRequest request =
DeleteTargetGrpcProxyRequest.newBuilder()
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setTargetGrpcProxy("targetGrpcProxy1045500511")
.build();
Operation response = targetGrpcProxiesClient.deleteAsync(request).get();
}
Name | Description |
request | DeleteTargetGrpcProxyRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
String project = "project-309310695";
String targetGrpcProxy = "targetGrpcProxy1045500511";
Operation response = targetGrpcProxiesClient.deleteAsync(project, targetGrpcProxy).get();
}
Name | Description |
project | String Project ID for this request. |
targetGrpcProxy | String Name of the TargetGrpcProxy resource to delete. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
GetTargetGrpcProxyRequest request =
GetTargetGrpcProxyRequest.newBuilder()
.setProject("project-309310695")
.setTargetGrpcProxy("targetGrpcProxy1045500511")
.build();
TargetGrpcProxy response = targetGrpcProxiesClient.get(request);
}
Name | Description |
request | GetTargetGrpcProxyRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
String project = "project-309310695";
String targetGrpcProxy = "targetGrpcProxy1045500511";
TargetGrpcProxy response = targetGrpcProxiesClient.get(project, targetGrpcProxy);
}
Name | Description |
project | String Project ID for this request. |
targetGrpcProxy | String Name of the TargetGrpcProxy resource to return. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Type | Description |
UnaryCallable<GetTargetGrpcProxyRequest,TargetGrpcProxy> |
getSettings()
public final TargetGrpcProxiesSettings getSettings()
Type | Description |
TargetGrpcProxiesSettings |
getStub()
public TargetGrpcProxiesStub getStub()
Type | Description |
TargetGrpcProxiesStub |
insertAsync(InsertTargetGrpcProxyRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertTargetGrpcProxyRequest request)
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Name | Description |
request | InsertTargetGrpcProxyRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
String project = "project-309310695";
TargetGrpcProxy targetGrpcProxyResource = TargetGrpcProxy.newBuilder().build();
Operation response =
targetGrpcProxiesClient.insertAsync(project, targetGrpcProxyResource).get();
}
Name | Description |
project | String Project ID for this request. |
targetGrpcProxyResource | TargetGrpcProxy The body resource for this request |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Type | Description |
OperationCallable<InsertTargetGrpcProxyRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
}
Name | Description |
request | ListTargetGrpcProxiesRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (TargetGrpcProxiesClient targetGrpcProxiesClient = TargetGrpcProxiesClient.create()) {
String project = "project-309310695";
for (TargetGrpcProxy element : targetGrpcProxiesClient.list(project).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
project | String Project ID for this request. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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;
}
}
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
}
Type | Description |
UnaryCallable<ListTargetGrpcProxiesRequest,ListPagedResponse> |
patchAsync(PatchTargetGrpcProxyRequest request)
public final OperationFuture<Operation,Operation> patchAsync(PatchTargetGrpcProxyRequest request)
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Name | Description |
request | PatchTargetGrpcProxyRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
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 |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Type | Description |
OperationCallable<PatchTargetGrpcProxyRequest,Operation,Operation> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()