@Generated(value="by gapic-generator-java") public class ForwardingRulesClient extends Object implements com.google.api.gax.core.BackgroundResource
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String forwardingRule = "forwardingRule-1429104743";
ForwardingRule response = forwardingRulesClient.get(project, region, forwardingRule);
}
Note: close() needs to be called on the ForwardingRulesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
AggregatedList |
Retrieves an aggregated list of forwarding rules. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Delete |
Deletes the specified ForwardingRule resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Get |
Returns the specified ForwardingRule resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Insert |
Creates a ForwardingRule resource in the specified project and region using the data included in the request. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
List |
Retrieves a list of ForwardingRule resources available to the specified project and region. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Patch |
Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetLabels |
Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetTarget |
Changes target URL for forwarding rule. The new target should be of the same type as the old target. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return 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 ForwardingRulesSettings 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
ForwardingRulesSettings forwardingRulesSettings =
ForwardingRulesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ForwardingRulesClient forwardingRulesClient =
ForwardingRulesClient.create(forwardingRulesSettings);
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
ForwardingRulesSettings forwardingRulesSettings =
ForwardingRulesSettings.newBuilder().setEndpoint(myEndpoint).build();
ForwardingRulesClient forwardingRulesClient =
ForwardingRulesClient.create(forwardingRulesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
| Modifier and Type | Class and Description |
|---|---|
static class |
ForwardingRulesClient.AggregatedListFixedSizeCollection |
static class |
ForwardingRulesClient.AggregatedListPage |
static class |
ForwardingRulesClient.AggregatedListPagedResponse |
static class |
ForwardingRulesClient.ListFixedSizeCollection |
static class |
ForwardingRulesClient.ListPage |
static class |
ForwardingRulesClient.ListPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
ForwardingRulesClient(ForwardingRulesSettings settings)
Constructs an instance of ForwardingRulesClient, using the given settings.
|
protected |
ForwardingRulesClient(ForwardingRulesStub stub) |
| Modifier and Type | Method and Description |
|---|---|
ForwardingRulesClient.AggregatedListPagedResponse |
aggregatedList(AggregatedListForwardingRulesRequest request)
Retrieves an aggregated list of forwarding rules.
|
ForwardingRulesClient.AggregatedListPagedResponse |
aggregatedList(String project)
Retrieves an aggregated list of forwarding rules.
|
com.google.api.gax.rpc.UnaryCallable<AggregatedListForwardingRulesRequest,ForwardingRuleAggregatedList> |
aggregatedListCallable()
Retrieves an aggregated list of forwarding rules.
|
com.google.api.gax.rpc.UnaryCallable<AggregatedListForwardingRulesRequest,ForwardingRulesClient.AggregatedListPagedResponse> |
aggregatedListPagedCallable()
Retrieves an aggregated list of forwarding rules.
|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static ForwardingRulesClient |
create()
Constructs an instance of ForwardingRulesClient with default settings.
|
static ForwardingRulesClient |
create(ForwardingRulesSettings settings)
Constructs an instance of ForwardingRulesClient, using the given settings.
|
static ForwardingRulesClient |
create(ForwardingRulesStub stub)
Constructs an instance of ForwardingRulesClient, using the given stub for making calls.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
deleteAsync(DeleteForwardingRuleRequest request)
Deletes the specified ForwardingRule resource.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
deleteAsync(String project,
String region,
String forwardingRule)
Deletes the specified ForwardingRule resource.
|
com.google.api.gax.rpc.UnaryCallable<DeleteForwardingRuleRequest,Operation> |
deleteCallable()
Deletes the specified ForwardingRule resource.
|
com.google.api.gax.rpc.OperationCallable<DeleteForwardingRuleRequest,Operation,Operation> |
deleteOperationCallable()
Deletes the specified ForwardingRule resource.
|
ForwardingRule |
get(GetForwardingRuleRequest request)
Returns the specified ForwardingRule resource.
|
ForwardingRule |
get(String project,
String region,
String forwardingRule)
Returns the specified ForwardingRule resource.
|
com.google.api.gax.rpc.UnaryCallable<GetForwardingRuleRequest,ForwardingRule> |
getCallable()
Returns the specified ForwardingRule resource.
|
ForwardingRulesSettings |
getSettings() |
ForwardingRulesStub |
getStub() |
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
insertAsync(InsertForwardingRuleRequest request)
Creates a ForwardingRule resource in the specified project and region using the data included
in the request.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
insertAsync(String project,
String region,
ForwardingRule forwardingRuleResource)
Creates a ForwardingRule resource in the specified project and region using the data included
in the request.
|
com.google.api.gax.rpc.UnaryCallable<InsertForwardingRuleRequest,Operation> |
insertCallable()
Creates a ForwardingRule resource in the specified project and region using the data included
in the request.
|
com.google.api.gax.rpc.OperationCallable<InsertForwardingRuleRequest,Operation,Operation> |
insertOperationCallable()
Creates a ForwardingRule resource in the specified project and region using the data included
in the request.
|
boolean |
isShutdown() |
boolean |
isTerminated() |
ForwardingRulesClient.ListPagedResponse |
list(ListForwardingRulesRequest request)
Retrieves a list of ForwardingRule resources available to the specified project and region.
|
ForwardingRulesClient.ListPagedResponse |
list(String project,
String region)
Retrieves a list of ForwardingRule resources available to the specified project and region.
|
com.google.api.gax.rpc.UnaryCallable<ListForwardingRulesRequest,ForwardingRuleList> |
listCallable()
Retrieves a list of ForwardingRule resources available to the specified project and region.
|
com.google.api.gax.rpc.UnaryCallable<ListForwardingRulesRequest,ForwardingRulesClient.ListPagedResponse> |
listPagedCallable()
Retrieves a list of ForwardingRule resources available to the specified project and region.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
patchAsync(PatchForwardingRuleRequest request)
Updates the specified forwarding rule with the data included in the request.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
patchAsync(String project,
String region,
String forwardingRule,
ForwardingRule forwardingRuleResource)
Updates the specified forwarding rule with the data included in the request.
|
com.google.api.gax.rpc.UnaryCallable<PatchForwardingRuleRequest,Operation> |
patchCallable()
Updates the specified forwarding rule with the data included in the request.
|
com.google.api.gax.rpc.OperationCallable<PatchForwardingRuleRequest,Operation,Operation> |
patchOperationCallable()
Updates the specified forwarding rule with the data included in the request.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
setLabelsAsync(SetLabelsForwardingRuleRequest request)
Sets the labels on the specified resource.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
setLabelsAsync(String project,
String region,
String resource,
RegionSetLabelsRequest regionSetLabelsRequestResource)
Sets the labels on the specified resource.
|
com.google.api.gax.rpc.UnaryCallable<SetLabelsForwardingRuleRequest,Operation> |
setLabelsCallable()
Sets the labels on the specified resource.
|
com.google.api.gax.rpc.OperationCallable<SetLabelsForwardingRuleRequest,Operation,Operation> |
setLabelsOperationCallable()
Sets the labels on the specified resource.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
setTargetAsync(SetTargetForwardingRuleRequest request)
Changes target URL for forwarding rule.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
setTargetAsync(String project,
String region,
String forwardingRule,
TargetReference targetReferenceResource)
Changes target URL for forwarding rule.
|
com.google.api.gax.rpc.UnaryCallable<SetTargetForwardingRuleRequest,Operation> |
setTargetCallable()
Changes target URL for forwarding rule.
|
com.google.api.gax.rpc.OperationCallable<SetTargetForwardingRuleRequest,Operation,Operation> |
setTargetOperationCallable()
Changes target URL for forwarding rule.
|
void |
shutdown() |
void |
shutdownNow() |
protected ForwardingRulesClient(ForwardingRulesSettings settings) throws IOException
IOExceptionprotected ForwardingRulesClient(ForwardingRulesStub stub)
public static final ForwardingRulesClient create() throws IOException
IOExceptionpublic static final ForwardingRulesClient create(ForwardingRulesSettings settings) throws IOException
IOExceptionpublic static final ForwardingRulesClient create(ForwardingRulesStub stub)
public final ForwardingRulesSettings getSettings()
public ForwardingRulesStub getStub()
public final ForwardingRulesClient.AggregatedListPagedResponse aggregatedList(String project)
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
String project = "project-309310695";
for (Map.Entry<String, ForwardingRulesScopedList> element :
forwardingRulesClient.aggregatedList(project).iterateAll()) {
// doThingsWith(element);
}
}
project - Project ID for this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ForwardingRulesClient.AggregatedListPagedResponse aggregatedList(AggregatedListForwardingRulesRequest 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
AggregatedListForwardingRulesRequest request =
AggregatedListForwardingRulesRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setServiceProjectNumber(-1293855239)
.build();
for (Map.Entry<String, ForwardingRulesScopedList> element :
forwardingRulesClient.aggregatedList(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<AggregatedListForwardingRulesRequest,ForwardingRulesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
AggregatedListForwardingRulesRequest request =
AggregatedListForwardingRulesRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setServiceProjectNumber(-1293855239)
.build();
ApiFuture<Map.Entry<String, ForwardingRulesScopedList>> future =
forwardingRulesClient.aggregatedListPagedCallable().futureCall(request);
// Do something.
for (Map.Entry<String, ForwardingRulesScopedList> element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListForwardingRulesRequest,ForwardingRuleAggregatedList> aggregatedListCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
AggregatedListForwardingRulesRequest request =
AggregatedListForwardingRulesRequest.newBuilder()
.setFilter("filter-1274492040")
.setIncludeAllScopes(true)
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setServiceProjectNumber(-1293855239)
.build();
while (true) {
ForwardingRuleAggregatedList response =
forwardingRulesClient.aggregatedListCallable().call(request);
for (Map.Entry<String, ForwardingRulesScopedList> element : response.getItemsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project, String region, String forwardingRule)
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String forwardingRule = "forwardingRule-1429104743";
Operation response = forwardingRulesClient.deleteAsync(project, region, forwardingRule).get();
}
project - Project ID for this request.region - Name of the region scoping this request.forwardingRule - Name of the ForwardingRule resource to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteForwardingRuleRequest 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
DeleteForwardingRuleRequest request =
DeleteForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = forwardingRulesClient.deleteAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<DeleteForwardingRuleRequest,Operation,Operation> deleteOperationCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
DeleteForwardingRuleRequest request =
DeleteForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
forwardingRulesClient.deleteOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<DeleteForwardingRuleRequest,Operation> deleteCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
DeleteForwardingRuleRequest request =
DeleteForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = forwardingRulesClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final ForwardingRule get(String project, String region, String forwardingRule)
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String forwardingRule = "forwardingRule-1429104743";
ForwardingRule response = forwardingRulesClient.get(project, region, forwardingRule);
}
project - Project ID for this request.region - Name of the region scoping this request.forwardingRule - Name of the ForwardingRule resource to return.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ForwardingRule get(GetForwardingRuleRequest 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
GetForwardingRuleRequest request =
GetForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setProject("project-309310695")
.setRegion("region-934795532")
.build();
ForwardingRule response = forwardingRulesClient.get(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetForwardingRuleRequest,ForwardingRule> getCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
GetForwardingRuleRequest request =
GetForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setProject("project-309310695")
.setRegion("region-934795532")
.build();
ApiFuture<ForwardingRule> future = forwardingRulesClient.getCallable().futureCall(request);
// Do something.
ForwardingRule response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project, String region, ForwardingRule forwardingRuleResource)
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
ForwardingRule forwardingRuleResource = ForwardingRule.newBuilder().build();
Operation response =
forwardingRulesClient.insertAsync(project, region, forwardingRuleResource).get();
}
project - Project ID for this request.region - Name of the region scoping this request.forwardingRuleResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertForwardingRuleRequest 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
InsertForwardingRuleRequest request =
InsertForwardingRuleRequest.newBuilder()
.setForwardingRuleResource(ForwardingRule.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = forwardingRulesClient.insertAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<InsertForwardingRuleRequest,Operation,Operation> insertOperationCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
InsertForwardingRuleRequest request =
InsertForwardingRuleRequest.newBuilder()
.setForwardingRuleResource(ForwardingRule.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
forwardingRulesClient.insertOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<InsertForwardingRuleRequest,Operation> insertCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
InsertForwardingRuleRequest request =
InsertForwardingRuleRequest.newBuilder()
.setForwardingRuleResource(ForwardingRule.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = forwardingRulesClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final ForwardingRulesClient.ListPagedResponse list(String project, String region)
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
for (ForwardingRule element : forwardingRulesClient.list(project, region).iterateAll()) {
// doThingsWith(element);
}
}
project - Project ID for this request.region - Name of the region scoping this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ForwardingRulesClient.ListPagedResponse list(ListForwardingRulesRequest 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
ListForwardingRulesRequest request =
ListForwardingRulesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
for (ForwardingRule element : forwardingRulesClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListForwardingRulesRequest,ForwardingRulesClient.ListPagedResponse> listPagedCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
ListForwardingRulesRequest request =
ListForwardingRulesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
ApiFuture<ForwardingRule> future =
forwardingRulesClient.listPagedCallable().futureCall(request);
// Do something.
for (ForwardingRule element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListForwardingRulesRequest,ForwardingRuleList> listCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
ListForwardingRulesRequest request =
ListForwardingRulesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
while (true) {
ForwardingRuleList response = forwardingRulesClient.listCallable().call(request);
for (ForwardingRule element : response.getItemsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(String project, String region, String forwardingRule, ForwardingRule forwardingRuleResource)
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String forwardingRule = "forwardingRule-1429104743";
ForwardingRule forwardingRuleResource = ForwardingRule.newBuilder().build();
Operation response =
forwardingRulesClient
.patchAsync(project, region, forwardingRule, forwardingRuleResource)
.get();
}
project - Project ID for this request.region - Name of the region scoping this request.forwardingRule - Name of the ForwardingRule resource to patch.forwardingRuleResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> patchAsync(PatchForwardingRuleRequest 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
PatchForwardingRuleRequest request =
PatchForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setForwardingRuleResource(ForwardingRule.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = forwardingRulesClient.patchAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<PatchForwardingRuleRequest,Operation,Operation> patchOperationCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
PatchForwardingRuleRequest request =
PatchForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setForwardingRuleResource(ForwardingRule.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
forwardingRulesClient.patchOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<PatchForwardingRuleRequest,Operation> patchCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
PatchForwardingRuleRequest request =
PatchForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setForwardingRuleResource(ForwardingRule.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = forwardingRulesClient.patchCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource)
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String resource = "resource-341064690";
RegionSetLabelsRequest regionSetLabelsRequestResource =
RegionSetLabelsRequest.newBuilder().build();
Operation response =
forwardingRulesClient
.setLabelsAsync(project, region, resource, regionSetLabelsRequestResource)
.get();
}
project - Project ID for this request.region - The region for this request.resource - Name or id of the resource for this request.regionSetLabelsRequestResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsForwardingRuleRequest 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
SetLabelsForwardingRuleRequest request =
SetLabelsForwardingRuleRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
.setRequestId("requestId693933066")
.setResource("resource-341064690")
.build();
Operation response = forwardingRulesClient.setLabelsAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<SetLabelsForwardingRuleRequest,Operation,Operation> setLabelsOperationCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
SetLabelsForwardingRuleRequest request =
SetLabelsForwardingRuleRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
.setRequestId("requestId693933066")
.setResource("resource-341064690")
.build();
OperationFuture<Operation, Operation> future =
forwardingRulesClient.setLabelsOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<SetLabelsForwardingRuleRequest,Operation> setLabelsCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
SetLabelsForwardingRuleRequest request =
SetLabelsForwardingRuleRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
.setRequestId("requestId693933066")
.setResource("resource-341064690")
.build();
ApiFuture<Operation> future = forwardingRulesClient.setLabelsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setTargetAsync(String project, String region, String forwardingRule, TargetReference targetReferenceResource)
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String forwardingRule = "forwardingRule-1429104743";
TargetReference targetReferenceResource = TargetReference.newBuilder().build();
Operation response =
forwardingRulesClient
.setTargetAsync(project, region, forwardingRule, targetReferenceResource)
.get();
}
project - Project ID for this request.region - Name of the region scoping this request.forwardingRule - Name of the ForwardingRule resource in which target is to be set.targetReferenceResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setTargetAsync(SetTargetForwardingRuleRequest 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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
SetTargetForwardingRuleRequest request =
SetTargetForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setTargetReferenceResource(TargetReference.newBuilder().build())
.build();
Operation response = forwardingRulesClient.setTargetAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<SetTargetForwardingRuleRequest,Operation,Operation> setTargetOperationCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
SetTargetForwardingRuleRequest request =
SetTargetForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setTargetReferenceResource(TargetReference.newBuilder().build())
.build();
OperationFuture<Operation, Operation> future =
forwardingRulesClient.setTargetOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final com.google.api.gax.rpc.UnaryCallable<SetTargetForwardingRuleRequest,Operation> setTargetCallable()
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 (ForwardingRulesClient forwardingRulesClient = ForwardingRulesClient.create()) {
SetTargetForwardingRuleRequest request =
SetTargetForwardingRuleRequest.newBuilder()
.setForwardingRule("forwardingRule-1429104743")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.setTargetReferenceResource(TargetReference.newBuilder().build())
.build();
ApiFuture<Operation> future = forwardingRulesClient.setTargetCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2024 Google LLC. All rights reserved.