Class UrlMapsClient (1.52.0)

GitHub RepositoryProduct Reference

Service Description: The UrlMaps 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   String urlMap = "urlMap-836780691";
   UrlMap response = urlMapsClient.get(project, urlMap);
 }

Note: close() needs to be called on the UrlMapsClient 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

AggregatedList

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. 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.

  • aggregatedList(AggregatedListUrlMapsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • aggregatedList(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.

  • aggregatedListPagedCallable()

  • aggregatedListCallable()

Delete

Deletes the specified UrlMap resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAsync(DeleteUrlMapRequest 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 urlMap)

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 UrlMap resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetUrlMapRequest 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 urlMap)

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 UrlMap resource in the specified project 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.

  • insertAsync(InsertUrlMapRequest 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, UrlMap urlMapResource)

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()

InvalidateCache

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • invalidateCacheAsync(InvalidateCacheUrlMapRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • invalidateCacheAsync(String project, String urlMap, CacheInvalidationRule cacheInvalidationRuleResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • invalidateCacheOperationCallable()

  • invalidateCacheCallable()

List

Retrieves the list of UrlMap resources available to the specified project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListUrlMapsRequest 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 UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the 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(PatchUrlMapRequest 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 urlMap, UrlMap urlMapResource)

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()

Update

Updates the specified UrlMap resource with the data included in the request.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAsync(UpdateUrlMapRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateAsync(String project, String urlMap, UrlMap urlMapResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateOperationCallable()

  • updateCallable()

Validate

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • validate(ValidateUrlMapRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • validate(String project, String urlMap, UrlMapsValidateRequest urlMapsValidateRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • validateCallable()

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 UrlMapsSettings 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
 UrlMapsSettings urlMapsSettings =
     UrlMapsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UrlMapsClient urlMapsClient = UrlMapsClient.create(urlMapsSettings);

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
 UrlMapsSettings urlMapsSettings = UrlMapsSettings.newBuilder().setEndpoint(myEndpoint).build();
 UrlMapsClient urlMapsClient = UrlMapsClient.create(urlMapsSettings);

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

Inheritance

java.lang.Object > UrlMapsClient

Static Methods

create()

public static final UrlMapsClient create()

Constructs an instance of UrlMapsClient with default settings.

Returns
Type Description
UrlMapsClient
Exceptions
Type Description
IOException

create(UrlMapsSettings settings)

public static final UrlMapsClient create(UrlMapsSettings settings)

Constructs an instance of UrlMapsClient, 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 UrlMapsSettings
Returns
Type Description
UrlMapsClient
Exceptions
Type Description
IOException

create(UrlMapsStub stub)

public static final UrlMapsClient create(UrlMapsStub stub)

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

Parameter
Name Description
stub UrlMapsStub
Returns
Type Description
UrlMapsClient

Constructors

UrlMapsClient(UrlMapsSettings settings)

protected UrlMapsClient(UrlMapsSettings settings)

Constructs an instance of UrlMapsClient, 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 UrlMapsSettings

UrlMapsClient(UrlMapsStub stub)

protected UrlMapsClient(UrlMapsStub stub)
Parameter
Name Description
stub UrlMapsStub

Methods

aggregatedList(AggregatedListUrlMapsRequest request)

public final UrlMapsClient.AggregatedListPagedResponse aggregatedList(AggregatedListUrlMapsRequest request)

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   AggregatedListUrlMapsRequest request =
       AggregatedListUrlMapsRequest.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, UrlMapsScopedList> element :
       urlMapsClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListUrlMapsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
UrlMapsClient.AggregatedListPagedResponse

aggregatedList(String project)

public final UrlMapsClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, UrlMapsScopedList> element :
       urlMapsClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Name of the project scoping this request.
Returns
Type Description
UrlMapsClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListUrlMapsRequest,UrlMapsAggregatedList> aggregatedListCallable()

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   AggregatedListUrlMapsRequest request =
       AggregatedListUrlMapsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     UrlMapsAggregatedList response = urlMapsClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, UrlMapsScopedList> 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<AggregatedListUrlMapsRequest,UrlMapsAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListUrlMapsRequest,UrlMapsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   AggregatedListUrlMapsRequest request =
       AggregatedListUrlMapsRequest.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, UrlMapsScopedList>> future =
       urlMapsClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, UrlMapsScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListUrlMapsRequest,AggregatedListPagedResponse>

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(DeleteUrlMapRequest request)

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

Deletes the specified UrlMap resource.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   DeleteUrlMapRequest request =
       DeleteUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .build();
   Operation response = urlMapsClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteUrlMapRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String urlMap)

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

Deletes the specified UrlMap resource.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   String urlMap = "urlMap-836780691";
   Operation response = urlMapsClient.deleteAsync(project, urlMap).get();
 }
Parameters
Name Description
project String

Project ID for this request.
urlMap String

Name of the UrlMap resource to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteUrlMapRequest,Operation> deleteCallable()

Deletes the specified UrlMap resource.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   DeleteUrlMapRequest request =
       DeleteUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .build();
   ApiFuture<Operation> future = urlMapsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteUrlMapRequest,Operation>

deleteOperationCallable()

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

Deletes the specified UrlMap resource.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   DeleteUrlMapRequest request =
       DeleteUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .build();
   OperationFuture<Operation, Operation> future =
       urlMapsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteUrlMapRequest,Operation,Operation>

get(GetUrlMapRequest request)

public final UrlMap get(GetUrlMapRequest request)

Returns the specified UrlMap resource.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   GetUrlMapRequest request =
       GetUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setUrlMap("urlMap-836780691")
           .build();
   UrlMap response = urlMapsClient.get(request);
 }
Parameter
Name Description
request GetUrlMapRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
UrlMap

get(String project, String urlMap)

public final UrlMap get(String project, String urlMap)

Returns the specified UrlMap resource.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   String urlMap = "urlMap-836780691";
   UrlMap response = urlMapsClient.get(project, urlMap);
 }
Parameters
Name Description
project String

Project ID for this request.
urlMap String

Name of the UrlMap resource to return.
Returns
Type Description
UrlMap

getCallable()

public final UnaryCallable<GetUrlMapRequest,UrlMap> getCallable()

Returns the specified UrlMap resource.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   GetUrlMapRequest request =
       GetUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setUrlMap("urlMap-836780691")
           .build();
   ApiFuture<UrlMap> future = urlMapsClient.getCallable().futureCall(request);
   // Do something.
   UrlMap response = future.get();
 }
Returns
Type Description
UnaryCallable<GetUrlMapRequest,UrlMap>

getSettings()

public final UrlMapsSettings getSettings()
Returns
Type Description
UrlMapsSettings

getStub()

public UrlMapsStub getStub()
Returns
Type Description
UrlMapsStub

insertAsync(InsertUrlMapRequest request)

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

Creates a UrlMap resource in the specified project using the data 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   InsertUrlMapRequest request =
       InsertUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   Operation response = urlMapsClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertUrlMapRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, UrlMap urlMapResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, UrlMap urlMapResource)

Creates a UrlMap resource in the specified project using the data 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   Operation response = urlMapsClient.insertAsync(project, urlMapResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
urlMapResource UrlMap

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertUrlMapRequest,Operation> insertCallable()

Creates a UrlMap resource in the specified project using the data 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   InsertUrlMapRequest request =
       InsertUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   ApiFuture<Operation> future = urlMapsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertUrlMapRequest,Operation>

insertOperationCallable()

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

Creates a UrlMap resource in the specified project using the data 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   InsertUrlMapRequest request =
       InsertUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       urlMapsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertUrlMapRequest,Operation,Operation>

invalidateCacheAsync(InvalidateCacheUrlMapRequest request)

public final OperationFuture<Operation,Operation> invalidateCacheAsync(InvalidateCacheUrlMapRequest request)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   InvalidateCacheUrlMapRequest request =
       InvalidateCacheUrlMapRequest.newBuilder()
           .setCacheInvalidationRuleResource(CacheInvalidationRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .build();
   Operation response = urlMapsClient.invalidateCacheAsync(request).get();
 }
Parameter
Name Description
request InvalidateCacheUrlMapRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

invalidateCacheAsync(String project, String urlMap, CacheInvalidationRule cacheInvalidationRuleResource)

public final OperationFuture<Operation,Operation> invalidateCacheAsync(String project, String urlMap, CacheInvalidationRule cacheInvalidationRuleResource)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   String urlMap = "urlMap-836780691";
   CacheInvalidationRule cacheInvalidationRuleResource =
       CacheInvalidationRule.newBuilder().build();
   Operation response =
       urlMapsClient.invalidateCacheAsync(project, urlMap, cacheInvalidationRuleResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
urlMap String

Name of the UrlMap scoping this request.
cacheInvalidationRuleResource CacheInvalidationRule

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

invalidateCacheCallable()

public final UnaryCallable<InvalidateCacheUrlMapRequest,Operation> invalidateCacheCallable()

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   InvalidateCacheUrlMapRequest request =
       InvalidateCacheUrlMapRequest.newBuilder()
           .setCacheInvalidationRuleResource(CacheInvalidationRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .build();
   ApiFuture<Operation> future = urlMapsClient.invalidateCacheCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InvalidateCacheUrlMapRequest,Operation>

invalidateCacheOperationCallable()

public final OperationCallable<InvalidateCacheUrlMapRequest,Operation,Operation> invalidateCacheOperationCallable()

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   InvalidateCacheUrlMapRequest request =
       InvalidateCacheUrlMapRequest.newBuilder()
           .setCacheInvalidationRuleResource(CacheInvalidationRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .build();
   OperationFuture<Operation, Operation> future =
       urlMapsClient.invalidateCacheOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InvalidateCacheUrlMapRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListUrlMapsRequest request)

public final UrlMapsClient.ListPagedResponse list(ListUrlMapsRequest request)

Retrieves the list of UrlMap resources available to the specified 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   ListUrlMapsRequest request =
       ListUrlMapsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (UrlMap element : urlMapsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListUrlMapsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
UrlMapsClient.ListPagedResponse

list(String project)

public final UrlMapsClient.ListPagedResponse list(String project)

Retrieves the list of UrlMap resources available to the specified 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   for (UrlMap element : urlMapsClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
UrlMapsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListUrlMapsRequest,UrlMapList> listCallable()

Retrieves the list of UrlMap resources available to the specified 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   ListUrlMapsRequest request =
       ListUrlMapsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     UrlMapList response = urlMapsClient.listCallable().call(request);
     for (UrlMap 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<ListUrlMapsRequest,UrlMapList>

listPagedCallable()

public final UnaryCallable<ListUrlMapsRequest,UrlMapsClient.ListPagedResponse> listPagedCallable()

Retrieves the list of UrlMap resources available to the specified 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   ListUrlMapsRequest request =
       ListUrlMapsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<UrlMap> future = urlMapsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (UrlMap element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListUrlMapsRequest,ListPagedResponse>

patchAsync(PatchUrlMapRequest request)

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

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   PatchUrlMapRequest request =
       PatchUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   Operation response = urlMapsClient.patchAsync(request).get();
 }
Parameter
Name Description
request PatchUrlMapRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

patchAsync(String project, String urlMap, UrlMap urlMapResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String urlMap, UrlMap urlMapResource)

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   String urlMap = "urlMap-836780691";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   Operation response = urlMapsClient.patchAsync(project, urlMap, urlMapResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
urlMap String

Name of the UrlMap resource to patch.
urlMapResource UrlMap

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchUrlMapRequest,Operation> patchCallable()

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   PatchUrlMapRequest request =
       PatchUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   ApiFuture<Operation> future = urlMapsClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<PatchUrlMapRequest,Operation>

patchOperationCallable()

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

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   PatchUrlMapRequest request =
       PatchUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       urlMapsClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<PatchUrlMapRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdateUrlMapRequest request)

public final OperationFuture<Operation,Operation> updateAsync(UpdateUrlMapRequest request)

Updates the specified UrlMap resource with the data 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   UpdateUrlMapRequest request =
       UpdateUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   Operation response = urlMapsClient.updateAsync(request).get();
 }
Parameter
Name Description
request UpdateUrlMapRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

updateAsync(String project, String urlMap, UrlMap urlMapResource)

public final OperationFuture<Operation,Operation> updateAsync(String project, String urlMap, UrlMap urlMapResource)

Updates the specified UrlMap resource with the data 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   String urlMap = "urlMap-836780691";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   Operation response = urlMapsClient.updateAsync(project, urlMap, urlMapResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
urlMap String

Name of the UrlMap resource to update.
urlMapResource UrlMap

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

updateCallable()

public final UnaryCallable<UpdateUrlMapRequest,Operation> updateCallable()

Updates the specified UrlMap resource with the data 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   UpdateUrlMapRequest request =
       UpdateUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   ApiFuture<Operation> future = urlMapsClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateUrlMapRequest,Operation>

updateOperationCallable()

public final OperationCallable<UpdateUrlMapRequest,Operation,Operation> updateOperationCallable()

Updates the specified UrlMap resource with the data 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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   UpdateUrlMapRequest request =
       UpdateUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       urlMapsClient.updateOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateUrlMapRequest,Operation,Operation>

validate(ValidateUrlMapRequest request)

public final UrlMapsValidateResponse validate(ValidateUrlMapRequest request)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   ValidateUrlMapRequest request =
       ValidateUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setUrlMap("urlMap-836780691")
           .setUrlMapsValidateRequestResource(UrlMapsValidateRequest.newBuilder().build())
           .build();
   UrlMapsValidateResponse response = urlMapsClient.validate(request);
 }
Parameter
Name Description
request ValidateUrlMapRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
UrlMapsValidateResponse

validate(String project, String urlMap, UrlMapsValidateRequest urlMapsValidateRequestResource)

public final UrlMapsValidateResponse validate(String project, String urlMap, UrlMapsValidateRequest urlMapsValidateRequestResource)

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   String urlMap = "urlMap-836780691";
   UrlMapsValidateRequest urlMapsValidateRequestResource =
       UrlMapsValidateRequest.newBuilder().build();
   UrlMapsValidateResponse response =
       urlMapsClient.validate(project, urlMap, urlMapsValidateRequestResource);
 }
Parameters
Name Description
project String

Project ID for this request.
urlMap String

Name of the UrlMap resource to be validated as.
urlMapsValidateRequestResource UrlMapsValidateRequest

The body resource for this request
Returns
Type Description
UrlMapsValidateResponse

validateCallable()

public final UnaryCallable<ValidateUrlMapRequest,UrlMapsValidateResponse> validateCallable()

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

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 (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   ValidateUrlMapRequest request =
       ValidateUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setUrlMap("urlMap-836780691")
           .setUrlMapsValidateRequestResource(UrlMapsValidateRequest.newBuilder().build())
           .build();
   ApiFuture<UrlMapsValidateResponse> future =
       urlMapsClient.validateCallable().futureCall(request);
   // Do something.
   UrlMapsValidateResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<ValidateUrlMapRequest,UrlMapsValidateResponse>