Class UrlMapsClient (1.6.0-beta)

public class UrlMapsClient implements BackgroundResource

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:


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

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of UrlMapsSettings to create(). For example:

To customize credentials:


 UrlMapsSettings urlMapsSettings =
     UrlMapsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UrlMapsClient urlMapsClient = UrlMapsClient.create(urlMapsSettings);
 

To customize the endpoint:


 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

Implements

BackgroundResource

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
NameDescription
settingsUrlMapsSettings

UrlMapsClient(UrlMapsStub stub)

protected UrlMapsClient(UrlMapsStub stub)
Parameter
NameDescription
stubUrlMapsStub

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.

Sample code:


 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)
           .build();
   for (Map.Entry
Parameter
NameDescription
requestAggregatedListUrlMapsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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.

Sample code:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   for (Map.Entry
Parameter
NameDescription
projectString

Name of the project scoping this request.

Returns
TypeDescription
UrlMapsClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListUrlMapsRequest,UrlMapsAggregatedList> aggregatedListCallable()

Retrieves the list of all UrlMap resources, regional and global, available to the specified project.

Sample code:


 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)
           .build();
   while (true) {
     UrlMapsAggregatedList response = urlMapsClient.aggregatedListCallable().call(request);
     for (Map.Entry
Returns
TypeDescription
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.

Sample code:


 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)
           .build();
   ApiFuture<>
Returns
TypeDescription
UnaryCallable<AggregatedListUrlMapsRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

create()

public static final UrlMapsClient create()

Constructs an instance of UrlMapsClient with default settings.

Returns
TypeDescription
UrlMapsClient
Exceptions
TypeDescription
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
NameDescription
settingsUrlMapsSettings
Returns
TypeDescription
UrlMapsClient
Exceptions
TypeDescription
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
NameDescription
stubUrlMapsStub
Returns
TypeDescription
UrlMapsClient

deleteAsync(DeleteUrlMapRequest request)

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

Deletes the specified UrlMap resource.

Sample code:


 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
NameDescription
requestDeleteUrlMapRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   String urlMap = "urlMap-836780691";
   Operation response = urlMapsClient.deleteAsync(project, urlMap).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

urlMapString

Name of the UrlMap resource to delete.

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteUrlMapRequest,Operation> deleteCallable()

Deletes the specified UrlMap resource.

Sample code:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   DeleteUrlMapRequest request =
       DeleteUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<DeleteUrlMapRequest,Operation>

deleteOperationCallable()

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

Deletes the specified UrlMap resource.

Sample code:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   DeleteUrlMapRequest request =
       DeleteUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<DeleteUrlMapRequest,Operation,Operation>

get(GetUrlMapRequest request)

public final UrlMap get(GetUrlMapRequest request)

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

Sample code:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   GetUrlMapRequest request =
       GetUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setUrlMap("urlMap-836780691")
           .build();
   UrlMap response = urlMapsClient.get(request);
 }
 
Parameter
NameDescription
requestGetUrlMapRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
UrlMap

get(String project, String urlMap)

public final UrlMap get(String project, String urlMap)

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

Sample code:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   String urlMap = "urlMap-836780691";
   UrlMap response = urlMapsClient.get(project, urlMap);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

urlMapString

Name of the UrlMap resource to return.

Returns
TypeDescription
UrlMap

getCallable()

public final UnaryCallable<GetUrlMapRequest,UrlMap> getCallable()

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

Sample code:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   GetUrlMapRequest request =
       GetUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setUrlMap("urlMap-836780691")
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<GetUrlMapRequest,UrlMap>

getSettings()

public final UrlMapsSettings getSettings()
Returns
TypeDescription
UrlMapsSettings

getStub()

public UrlMapsStub getStub()
Returns
TypeDescription
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:


 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
NameDescription
requestInsertUrlMapRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   Operation response = urlMapsClient.insertAsync(project, urlMapResource).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

urlMapResourceUrlMap

The body resource for this request

Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   InsertUrlMapRequest request =
       InsertUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   ApiFuture
Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   InsertUrlMapRequest request =
       InsertUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
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:


 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
NameDescription
requestInvalidateCacheUrlMapRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

urlMapString

Name of the UrlMap scoping this request.

cacheInvalidationRuleResourceCacheInvalidationRule

The body resource for this request

Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   InvalidateCacheUrlMapRequest request =
       InvalidateCacheUrlMapRequest.newBuilder()
           .setCacheInvalidationRuleResource(CacheInvalidationRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .build();
   ApiFuture
Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   InvalidateCacheUrlMapRequest request =
       InvalidateCacheUrlMapRequest.newBuilder()
           .setCacheInvalidationRuleResource(CacheInvalidationRule.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .build();
   OperationFuture
Returns
TypeDescription
OperationCallable<InvalidateCacheUrlMapRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

list(ListUrlMapsRequest request)

public final UrlMapsClient.ListPagedResponse list(ListUrlMapsRequest request)

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

Sample code:


 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
NameDescription
requestListUrlMapsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   String project = "project-309310695";
   for (UrlMap element : urlMapsClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
UrlMapsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListUrlMapsRequest,UrlMapList> listCallable()

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

Sample code:


 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListUrlMapsRequest,UrlMapList>

listPagedCallable()

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

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

Sample code:


 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
Returns
TypeDescription
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:


 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
NameDescription
requestPatchUrlMapRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

urlMapString

Name of the UrlMap resource to patch.

urlMapResourceUrlMap

The body resource for this request

Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   PatchUrlMapRequest request =
       PatchUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   ApiFuture
Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   PatchUrlMapRequest request =
       PatchUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
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:


 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
NameDescription
requestUpdateUrlMapRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

urlMapString

Name of the UrlMap resource to update.

urlMapResourceUrlMap

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

updateCallable()

public final UnaryCallable<UpdateUrlMapRequest,Operation> updateCallable()

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

Sample code:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   UpdateUrlMapRequest request =
       UpdateUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   ApiFuture
Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   UpdateUrlMapRequest request =
       UpdateUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setUrlMap("urlMap-836780691")
           .setUrlMapResource(UrlMap.newBuilder().build())
           .build();
   OperationFuture
Returns
TypeDescription
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:


 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
NameDescription
requestValidateUrlMapRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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:


 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
NameDescription
projectString

Project ID for this request.

urlMapString

Name of the UrlMap resource to be validated as.

urlMapsValidateRequestResourceUrlMapsValidateRequest

The body resource for this request

Returns
TypeDescription
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:


 try (UrlMapsClient urlMapsClient = UrlMapsClient.create()) {
   ValidateUrlMapRequest request =
       ValidateUrlMapRequest.newBuilder()
           .setProject("project-309310695")
           .setUrlMap("urlMap-836780691")
           .setUrlMapsValidateRequestResource(UrlMapsValidateRequest.newBuilder().build())
           .build();
   ApiFuture
Returns
TypeDescription
UnaryCallable<ValidateUrlMapRequest,UrlMapsValidateResponse>