Class UrlMapsClient (1.88.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: