com.google.cloud.compute.v1

Class UrlMapClient

java.lang.Object

com.google.cloud.compute.v1.UrlMapClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class UrlMapClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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 (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   Operation response = urlMapClient.deleteUrlMap(urlMap);
 }
 
 

Note: close() needs to be called on the urlMapClient 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 UrlMapSettings to create(). For example:

To customize credentials:

 
 UrlMapSettings urlMapSettings =
     UrlMapSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UrlMapClient urlMapClient =
     UrlMapClient.create(urlMapSettings);
 
 

To customize the endpoint:

 
 UrlMapSettings urlMapSettings =
     UrlMapSettings.newBuilder().setEndpoint(myEndpoint).build();
 UrlMapClient urlMapClient =
     UrlMapClient.create(urlMapSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UrlMapClient.AggregatedListUrlMapsFixedSizeCollection
static class	UrlMapClient.AggregatedListUrlMapsPage
static class	UrlMapClient.AggregatedListUrlMapsPagedResponse
static class	UrlMapClient.ListUrlMapsFixedSizeCollection
static class	UrlMapClient.ListUrlMapsPage
static class	UrlMapClient.ListUrlMapsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UrlMapClient(UrlMapSettings settings) Constructs an instance of UrlMapClient, using the given settings.
protected	UrlMapClient(UrlMapStub stub)

Method Summary

Modifier and Type	Method and Description
UrlMapClient.AggregatedListUrlMapsPagedResponse	aggregatedListUrlMaps(AggregatedListUrlMapsHttpRequest request) Retrieves the list of all UrlMap resources, regional and global, available to the specified project.
UrlMapClient.AggregatedListUrlMapsPagedResponse	aggregatedListUrlMaps(ProjectName project) Retrieves the list of all UrlMap resources, regional and global, available to the specified project.
UrlMapClient.AggregatedListUrlMapsPagedResponse	aggregatedListUrlMaps(String project) Retrieves the list of all UrlMap resources, regional and global, available to the specified project.
com.google.api.gax.rpc.UnaryCallable<AggregatedListUrlMapsHttpRequest,UrlMapsAggregatedList>	aggregatedListUrlMapsCallable() Retrieves the list of all UrlMap resources, regional and global, available to the specified project.
com.google.api.gax.rpc.UnaryCallable<AggregatedListUrlMapsHttpRequest,UrlMapClient.AggregatedListUrlMapsPagedResponse>	aggregatedListUrlMapsPagedCallable() Retrieves the list of all UrlMap resources, regional and global, available to the specified project.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static UrlMapClient	create() Constructs an instance of UrlMapClient with default settings.
static UrlMapClient	create(UrlMapSettings settings) Constructs an instance of UrlMapClient, using the given settings.
static UrlMapClient	create(UrlMapStub stub) Constructs an instance of UrlMapClient, using the given stub for making calls.
Operation	deleteUrlMap(DeleteUrlMapHttpRequest request) Deletes the specified UrlMap resource.
Operation	deleteUrlMap(ProjectGlobalUrlMapName urlMap) Deletes the specified UrlMap resource.
Operation	deleteUrlMap(String urlMap) Deletes the specified UrlMap resource.
com.google.api.gax.rpc.UnaryCallable<DeleteUrlMapHttpRequest,Operation>	deleteUrlMapCallable() Deletes the specified UrlMap resource.
UrlMapSettings	getSettings()
UrlMapStub	getStub()
UrlMap	getUrlMap(GetUrlMapHttpRequest request) Returns the specified UrlMap resource.
UrlMap	getUrlMap(ProjectGlobalUrlMapName urlMap) Returns the specified UrlMap resource.
UrlMap	getUrlMap(String urlMap) Returns the specified UrlMap resource.
com.google.api.gax.rpc.UnaryCallable<GetUrlMapHttpRequest,UrlMap>	getUrlMapCallable() Returns the specified UrlMap resource.
Operation	insertUrlMap(InsertUrlMapHttpRequest request) Creates a UrlMap resource in the specified project using the data included in the request.
Operation	insertUrlMap(ProjectName project, UrlMap urlMapResource) Creates a UrlMap resource in the specified project using the data included in the request.
Operation	insertUrlMap(String project, UrlMap urlMapResource) Creates a UrlMap resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertUrlMapHttpRequest,Operation>	insertUrlMapCallable() Creates a UrlMap resource in the specified project using the data included in the request.
Operation	invalidateCacheUrlMap(InvalidateCacheUrlMapHttpRequest request) Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
Operation	invalidateCacheUrlMap(ProjectGlobalUrlMapName urlMap, CacheInvalidationRule cacheInvalidationRuleResource) Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
Operation	invalidateCacheUrlMap(String urlMap, CacheInvalidationRule cacheInvalidationRuleResource) Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
com.google.api.gax.rpc.UnaryCallable<InvalidateCacheUrlMapHttpRequest,Operation>	invalidateCacheUrlMapCallable() Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
boolean	isShutdown()
boolean	isTerminated()
UrlMapClient.ListUrlMapsPagedResponse	listUrlMaps(ListUrlMapsHttpRequest request) Retrieves the list of UrlMap resources available to the specified project.
UrlMapClient.ListUrlMapsPagedResponse	listUrlMaps(ProjectName project) Retrieves the list of UrlMap resources available to the specified project.
UrlMapClient.ListUrlMapsPagedResponse	listUrlMaps(String project) Retrieves the list of UrlMap resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListUrlMapsHttpRequest,UrlMapList>	listUrlMapsCallable() Retrieves the list of UrlMap resources available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListUrlMapsHttpRequest,UrlMapClient.ListUrlMapsPagedResponse>	listUrlMapsPagedCallable() Retrieves the list of UrlMap resources available to the specified project.
Operation	patchUrlMap(PatchUrlMapHttpRequest request) Patches the specified UrlMap resource with the data included in the request.
Operation	patchUrlMap(ProjectGlobalUrlMapName urlMap, UrlMap urlMapResource, List<String> fieldMask) Patches the specified UrlMap resource with the data included in the request.
Operation	patchUrlMap(String urlMap, UrlMap urlMapResource, List<String> fieldMask) Patches the specified UrlMap resource with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<PatchUrlMapHttpRequest,Operation>	patchUrlMapCallable() Patches the specified UrlMap resource with the data included in the request.
void	shutdown()
void	shutdownNow()
Operation	updateUrlMap(ProjectGlobalUrlMapName urlMap, UrlMap urlMapResource, List<String> fieldMask) Updates the specified UrlMap resource with the data included in the request.
Operation	updateUrlMap(String urlMap, UrlMap urlMapResource, List<String> fieldMask) Updates the specified UrlMap resource with the data included in the request.
Operation	updateUrlMap(UpdateUrlMapHttpRequest request) Updates the specified UrlMap resource with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<UpdateUrlMapHttpRequest,Operation>	updateUrlMapCallable() Updates the specified UrlMap resource with the data included in the request.
UrlMapsValidateResponse	validateUrlMap(ProjectGlobalUrlMapName urlMap, UrlMapsValidateRequest urlMapsValidateRequestResource) Runs static validation for the UrlMap.
UrlMapsValidateResponse	validateUrlMap(String urlMap, UrlMapsValidateRequest urlMapsValidateRequestResource) Runs static validation for the UrlMap.
UrlMapsValidateResponse	validateUrlMap(ValidateUrlMapHttpRequest request) Runs static validation for the UrlMap.
com.google.api.gax.rpc.UnaryCallable<ValidateUrlMapHttpRequest,UrlMapsValidateResponse>	validateUrlMapCallable() Runs static validation for the UrlMap.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UrlMapClient

protected UrlMapClient(UrlMapSettings settings)
                throws IOException

Constructs an instance of UrlMapClient, 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.

Throws:

IOException

UrlMapClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected UrlMapClient(UrlMapStub stub)

Method Detail

create

public static final UrlMapClient create()
                                 throws IOException

Constructs an instance of UrlMapClient with default settings.

Throws:

IOException

create

public static final UrlMapClient create(UrlMapSettings settings)
                                 throws IOException

Constructs an instance of UrlMapClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final UrlMapClient create(UrlMapStub stub)

Constructs an instance of UrlMapClient, using the given stub for making calls. This is for advanced usage - prefer to use UrlMapSettings}.

getSettings

public final UrlMapSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public UrlMapStub getStub()

aggregatedListUrlMaps

@BetaApi
public final UrlMapClient.AggregatedListUrlMapsPagedResponse aggregatedListUrlMaps(ProjectName project)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (UrlMapsScopedList element : urlMapClient.aggregatedListUrlMaps(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Name of the project scoping this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListUrlMaps

@BetaApi
public final UrlMapClient.AggregatedListUrlMapsPagedResponse aggregatedListUrlMaps(String project)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (UrlMapsScopedList element : urlMapClient.aggregatedListUrlMaps(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Name of the project scoping this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListUrlMaps

@BetaApi
public final UrlMapClient.AggregatedListUrlMapsPagedResponse aggregatedListUrlMaps(AggregatedListUrlMapsHttpRequest request)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListUrlMapsHttpRequest request = AggregatedListUrlMapsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (UrlMapsScopedList element : urlMapClient.aggregatedListUrlMaps(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListUrlMapsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListUrlMapsHttpRequest,UrlMapClient.AggregatedListUrlMapsPagedResponse> aggregatedListUrlMapsPagedCallable()

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListUrlMapsHttpRequest request = AggregatedListUrlMapsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListUrlMapsPagedResponse> future = urlMapClient.aggregatedListUrlMapsPagedCallable().futureCall(request);
   // Do something
   for (UrlMapsScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListUrlMapsCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListUrlMapsHttpRequest,UrlMapsAggregatedList> aggregatedListUrlMapsCallable()

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListUrlMapsHttpRequest request = AggregatedListUrlMapsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     UrlMapsAggregatedList response = urlMapClient.aggregatedListUrlMapsCallable().call(request);
     for (UrlMapsScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteUrlMap

@BetaApi
public final Operation deleteUrlMap(ProjectGlobalUrlMapName urlMap)

Deletes the specified UrlMap resource.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   Operation response = urlMapClient.deleteUrlMap(urlMap);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteUrlMap

@BetaApi
public final Operation deleteUrlMap(String urlMap)

Deletes the specified UrlMap resource.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   Operation response = urlMapClient.deleteUrlMap(urlMap.toString());
 }
 

Parameters:

urlMap - Name of the UrlMap resource to delete.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteUrlMap

@BetaApi
public final Operation deleteUrlMap(DeleteUrlMapHttpRequest request)

Deletes the specified UrlMap resource.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   DeleteUrlMapHttpRequest request = DeleteUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .build();
   Operation response = urlMapClient.deleteUrlMap(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteUrlMapCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteUrlMapHttpRequest,Operation> deleteUrlMapCallable()

Deletes the specified UrlMap resource.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   DeleteUrlMapHttpRequest request = DeleteUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .build();
   ApiFuture<Operation> future = urlMapClient.deleteUrlMapCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getUrlMap

@BetaApi
public final UrlMap getUrlMap(ProjectGlobalUrlMapName urlMap)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   UrlMap response = urlMapClient.getUrlMap(urlMap);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getUrlMap

@BetaApi
public final UrlMap getUrlMap(String urlMap)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   UrlMap response = urlMapClient.getUrlMap(urlMap.toString());
 }
 

Parameters:

urlMap - Name of the UrlMap resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getUrlMap

@BetaApi
public final UrlMap getUrlMap(GetUrlMapHttpRequest request)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   GetUrlMapHttpRequest request = GetUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .build();
   UrlMap response = urlMapClient.getUrlMap(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getUrlMapCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetUrlMapHttpRequest,UrlMap> getUrlMapCallable()

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   GetUrlMapHttpRequest request = GetUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .build();
   ApiFuture<UrlMap> future = urlMapClient.getUrlMapCallable().futureCall(request);
   // Do something
   UrlMap response = future.get();
 }
 

insertUrlMap

@BetaApi
public final Operation insertUrlMap(ProjectName project,
                                             UrlMap urlMapResource)

Creates a UrlMap resource in the specified project using the data included in the request.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   Operation response = urlMapClient.insertUrlMap(project, urlMapResource);
 }
 

Parameters:

project - Project ID for this request.

urlMapResource - Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertUrlMap

@BetaApi
public final Operation insertUrlMap(String project,
                                             UrlMap urlMapResource)

Creates a UrlMap resource in the specified project using the data included in the request.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   Operation response = urlMapClient.insertUrlMap(project.toString(), urlMapResource);
 }
 

Parameters:

project - Project ID for this request.

urlMapResource - Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertUrlMap

@BetaApi
public final Operation insertUrlMap(InsertUrlMapHttpRequest request)

Creates a UrlMap resource in the specified project using the data included in the request.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   InsertUrlMapHttpRequest request = InsertUrlMapHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setUrlMapResource(urlMapResource)
     .build();
   Operation response = urlMapClient.insertUrlMap(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

insertUrlMapCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertUrlMapHttpRequest,Operation> insertUrlMapCallable()

Creates a UrlMap resource in the specified project using the data included in the request.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   InsertUrlMapHttpRequest request = InsertUrlMapHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setUrlMapResource(urlMapResource)
     .build();
   ApiFuture<Operation> future = urlMapClient.insertUrlMapCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

invalidateCacheUrlMap

@BetaApi
public final Operation invalidateCacheUrlMap(ProjectGlobalUrlMapName urlMap,
                                                      CacheInvalidationRule cacheInvalidationRuleResource)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   CacheInvalidationRule cacheInvalidationRuleResource = CacheInvalidationRule.newBuilder().build();
   Operation response = urlMapClient.invalidateCacheUrlMap(urlMap, cacheInvalidationRuleResource);
 }
 

Parameters:

urlMap - Name of the UrlMap scoping this request.

cacheInvalidationRuleResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

invalidateCacheUrlMap

@BetaApi
public final Operation invalidateCacheUrlMap(String urlMap,
                                                      CacheInvalidationRule cacheInvalidationRuleResource)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   CacheInvalidationRule cacheInvalidationRuleResource = CacheInvalidationRule.newBuilder().build();
   Operation response = urlMapClient.invalidateCacheUrlMap(urlMap.toString(), cacheInvalidationRuleResource);
 }
 

Parameters:

urlMap - Name of the UrlMap scoping this request.

cacheInvalidationRuleResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

invalidateCacheUrlMap

@BetaApi
public final Operation invalidateCacheUrlMap(InvalidateCacheUrlMapHttpRequest request)

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   CacheInvalidationRule cacheInvalidationRuleResource = CacheInvalidationRule.newBuilder().build();
   InvalidateCacheUrlMapHttpRequest request = InvalidateCacheUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setCacheInvalidationRuleResource(cacheInvalidationRuleResource)
     .build();
   Operation response = urlMapClient.invalidateCacheUrlMap(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

invalidateCacheUrlMapCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InvalidateCacheUrlMapHttpRequest,Operation> invalidateCacheUrlMapCallable()

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   CacheInvalidationRule cacheInvalidationRuleResource = CacheInvalidationRule.newBuilder().build();
   InvalidateCacheUrlMapHttpRequest request = InvalidateCacheUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setCacheInvalidationRuleResource(cacheInvalidationRuleResource)
     .build();
   ApiFuture<Operation> future = urlMapClient.invalidateCacheUrlMapCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listUrlMaps

@BetaApi
public final UrlMapClient.ListUrlMapsPagedResponse listUrlMaps(ProjectName project)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (UrlMap element : urlMapClient.listUrlMaps(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listUrlMaps

@BetaApi
public final UrlMapClient.ListUrlMapsPagedResponse listUrlMaps(String project)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (UrlMap element : urlMapClient.listUrlMaps(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listUrlMaps

@BetaApi
public final UrlMapClient.ListUrlMapsPagedResponse listUrlMaps(ListUrlMapsHttpRequest request)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListUrlMapsHttpRequest request = ListUrlMapsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (UrlMap element : urlMapClient.listUrlMaps(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listUrlMapsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListUrlMapsHttpRequest,UrlMapClient.ListUrlMapsPagedResponse> listUrlMapsPagedCallable()

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListUrlMapsHttpRequest request = ListUrlMapsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListUrlMapsPagedResponse> future = urlMapClient.listUrlMapsPagedCallable().futureCall(request);
   // Do something
   for (UrlMap element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listUrlMapsCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListUrlMapsHttpRequest,UrlMapList> listUrlMapsCallable()

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListUrlMapsHttpRequest request = ListUrlMapsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     UrlMapList response = urlMapClient.listUrlMapsCallable().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;
     }
   }
 }
 

patchUrlMap

@BetaApi
public final Operation patchUrlMap(ProjectGlobalUrlMapName urlMap,
                                            UrlMap urlMapResource,
                                            List<String> fieldMask)

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 (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = urlMapClient.patchUrlMap(urlMap, urlMapResource, fieldMask);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to patch.

urlMapResource - Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchUrlMap

@BetaApi
public final Operation patchUrlMap(String urlMap,
                                            UrlMap urlMapResource,
                                            List<String> fieldMask)

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 (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = urlMapClient.patchUrlMap(urlMap.toString(), urlMapResource, fieldMask);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to patch.

urlMapResource - Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchUrlMap

@BetaApi
public final Operation patchUrlMap(PatchUrlMapHttpRequest 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 (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchUrlMapHttpRequest request = PatchUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setUrlMapResource(urlMapResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = urlMapClient.patchUrlMap(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

patchUrlMapCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<PatchUrlMapHttpRequest,Operation> patchUrlMapCallable()

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 (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchUrlMapHttpRequest request = PatchUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setUrlMapResource(urlMapResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = urlMapClient.patchUrlMapCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateUrlMap

@BetaApi
public final Operation updateUrlMap(ProjectGlobalUrlMapName urlMap,
                                             UrlMap urlMapResource,
                                             List<String> fieldMask)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = urlMapClient.updateUrlMap(urlMap, urlMapResource, fieldMask);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to update.

urlMapResource - Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateUrlMap

@BetaApi
public final Operation updateUrlMap(String urlMap,
                                             UrlMap urlMapResource,
                                             List<String> fieldMask)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = urlMapClient.updateUrlMap(urlMap.toString(), urlMapResource, fieldMask);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to update.

urlMapResource - Represents a URL Map resource.

A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts.

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateUrlMap

@BetaApi
public final Operation updateUrlMap(UpdateUrlMapHttpRequest request)

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateUrlMapHttpRequest request = UpdateUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setUrlMapResource(urlMapResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = urlMapClient.updateUrlMap(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateUrlMapCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<UpdateUrlMapHttpRequest,Operation> updateUrlMapCallable()

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

Sample code:

 try (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateUrlMapHttpRequest request = UpdateUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setUrlMapResource(urlMapResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = urlMapClient.updateUrlMapCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

validateUrlMap

@BetaApi
public final UrlMapsValidateResponse validateUrlMap(ProjectGlobalUrlMapName 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 (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   UrlMapsValidateRequest urlMapsValidateRequestResource = UrlMapsValidateRequest.newBuilder().build();
   UrlMapsValidateResponse response = urlMapClient.validateUrlMap(urlMap, urlMapsValidateRequestResource);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to be validated as.

urlMapsValidateRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

validateUrlMap

@BetaApi
public final UrlMapsValidateResponse validateUrlMap(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 (UrlMapClient urlMapClient = UrlMapClient.create()) {
   ProjectGlobalUrlMapName urlMap = ProjectGlobalUrlMapName.of("[PROJECT]", "[URL_MAP]");
   UrlMapsValidateRequest urlMapsValidateRequestResource = UrlMapsValidateRequest.newBuilder().build();
   UrlMapsValidateResponse response = urlMapClient.validateUrlMap(urlMap.toString(), urlMapsValidateRequestResource);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to be validated as.

urlMapsValidateRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

validateUrlMap

@BetaApi
public final UrlMapsValidateResponse validateUrlMap(ValidateUrlMapHttpRequest 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 (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   UrlMapsValidateRequest urlMapsValidateRequestResource = UrlMapsValidateRequest.newBuilder().build();
   ValidateUrlMapHttpRequest request = ValidateUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setUrlMapsValidateRequestResource(urlMapsValidateRequestResource)
     .build();
   UrlMapsValidateResponse response = urlMapClient.validateUrlMap(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

validateUrlMapCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ValidateUrlMapHttpRequest,UrlMapsValidateResponse> validateUrlMapCallable()

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 (UrlMapClient urlMapClient = UrlMapClient.create()) {
   String formattedUrlMap = ProjectGlobalUrlMapName.format("[PROJECT]", "[URL_MAP]");
   UrlMapsValidateRequest urlMapsValidateRequestResource = UrlMapsValidateRequest.newBuilder().build();
   ValidateUrlMapHttpRequest request = ValidateUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setUrlMapsValidateRequestResource(urlMapsValidateRequestResource)
     .build();
   ApiFuture<UrlMapsValidateResponse> future = urlMapClient.validateUrlMapCallable().futureCall(request);
   // Do something
   UrlMapsValidateResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException