com.google.cloud.compute.v1

Class RegionUrlMapClient

java.lang.Object

com.google.cloud.compute.v1.RegionUrlMapClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class RegionUrlMapClient
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 (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   Operation response = regionUrlMapClient.deleteRegionUrlMap(urlMap, requestId);
 }
 
 

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

To customize credentials:

 
 RegionUrlMapSettings regionUrlMapSettings =
     RegionUrlMapSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionUrlMapClient regionUrlMapClient =
     RegionUrlMapClient.create(regionUrlMapSettings);
 
 

To customize the endpoint:

 
 RegionUrlMapSettings regionUrlMapSettings =
     RegionUrlMapSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionUrlMapClient regionUrlMapClient =
     RegionUrlMapClient.create(regionUrlMapSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionUrlMapClient.ListRegionUrlMapsFixedSizeCollection
static class	RegionUrlMapClient.ListRegionUrlMapsPage
static class	RegionUrlMapClient.ListRegionUrlMapsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionUrlMapClient(RegionUrlMapSettings settings) Constructs an instance of RegionUrlMapClient, using the given settings.
protected	RegionUrlMapClient(RegionUrlMapStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RegionUrlMapClient	create() Constructs an instance of RegionUrlMapClient with default settings.
static RegionUrlMapClient	create(RegionUrlMapSettings settings) Constructs an instance of RegionUrlMapClient, using the given settings.
static RegionUrlMapClient	create(RegionUrlMapStub stub) Constructs an instance of RegionUrlMapClient, using the given stub for making calls.
Operation	deleteRegionUrlMap(DeleteRegionUrlMapHttpRequest request) Deletes the specified UrlMap resource.
Operation	deleteRegionUrlMap(ProjectRegionUrlMapName urlMap, String requestId) Deletes the specified UrlMap resource.
Operation	deleteRegionUrlMap(String urlMap, String requestId) Deletes the specified UrlMap resource.
com.google.api.gax.rpc.UnaryCallable<DeleteRegionUrlMapHttpRequest,Operation>	deleteRegionUrlMapCallable() Deletes the specified UrlMap resource.
UrlMap	getRegionUrlMap(GetRegionUrlMapHttpRequest request) Returns the specified UrlMap resource.
UrlMap	getRegionUrlMap(ProjectRegionUrlMapName urlMap) Returns the specified UrlMap resource.
UrlMap	getRegionUrlMap(String urlMap) Returns the specified UrlMap resource.
com.google.api.gax.rpc.UnaryCallable<GetRegionUrlMapHttpRequest,UrlMap>	getRegionUrlMapCallable() Returns the specified UrlMap resource.
RegionUrlMapSettings	getSettings()
RegionUrlMapStub	getStub()
Operation	insertRegionUrlMap(InsertRegionUrlMapHttpRequest request) Creates a UrlMap resource in the specified project using the data included in the request.
Operation	insertRegionUrlMap(String requestId, ProjectRegionName region, UrlMap urlMapResource) Creates a UrlMap resource in the specified project using the data included in the request.
Operation	insertRegionUrlMap(String requestId, String region, UrlMap urlMapResource) Creates a UrlMap resource in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertRegionUrlMapHttpRequest,Operation>	insertRegionUrlMapCallable() Creates a UrlMap resource in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
RegionUrlMapClient.ListRegionUrlMapsPagedResponse	listRegionUrlMaps(ListRegionUrlMapsHttpRequest request) Retrieves the list of UrlMap resources available to the specified project in the specified region.
RegionUrlMapClient.ListRegionUrlMapsPagedResponse	listRegionUrlMaps(ProjectRegionName region) Retrieves the list of UrlMap resources available to the specified project in the specified region.
RegionUrlMapClient.ListRegionUrlMapsPagedResponse	listRegionUrlMaps(String region) Retrieves the list of UrlMap resources available to the specified project in the specified region.
com.google.api.gax.rpc.UnaryCallable<ListRegionUrlMapsHttpRequest,UrlMapList>	listRegionUrlMapsCallable() Retrieves the list of UrlMap resources available to the specified project in the specified region.
com.google.api.gax.rpc.UnaryCallable<ListRegionUrlMapsHttpRequest,RegionUrlMapClient.ListRegionUrlMapsPagedResponse>	listRegionUrlMapsPagedCallable() Retrieves the list of UrlMap resources available to the specified project in the specified region.
Operation	patchRegionUrlMap(PatchRegionUrlMapHttpRequest request) Patches the specified UrlMap resource with the data included in the request.
Operation	patchRegionUrlMap(ProjectRegionUrlMapName urlMap, String requestId, UrlMap urlMapResource, List<String> fieldMask) Patches the specified UrlMap resource with the data included in the request.
Operation	patchRegionUrlMap(String urlMap, String requestId, UrlMap urlMapResource, List<String> fieldMask) Patches the specified UrlMap resource with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<PatchRegionUrlMapHttpRequest,Operation>	patchRegionUrlMapCallable() Patches the specified UrlMap resource with the data included in the request.
void	shutdown()
void	shutdownNow()
Operation	updateRegionUrlMap(ProjectRegionUrlMapName urlMap, String requestId, UrlMap urlMapResource, List<String> fieldMask) Updates the specified UrlMap resource with the data included in the request.
Operation	updateRegionUrlMap(String urlMap, String requestId, UrlMap urlMapResource, List<String> fieldMask) Updates the specified UrlMap resource with the data included in the request.
Operation	updateRegionUrlMap(UpdateRegionUrlMapHttpRequest request) Updates the specified UrlMap resource with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<UpdateRegionUrlMapHttpRequest,Operation>	updateRegionUrlMapCallable() Updates the specified UrlMap resource with the data included in the request.
UrlMapsValidateResponse	validateRegionUrlMap(ProjectRegionUrlMapName urlMap, RegionUrlMapsValidateRequest regionUrlMapsValidateRequestResource) Runs static validation for the UrlMap.
UrlMapsValidateResponse	validateRegionUrlMap(String urlMap, RegionUrlMapsValidateRequest regionUrlMapsValidateRequestResource) Runs static validation for the UrlMap.
UrlMapsValidateResponse	validateRegionUrlMap(ValidateRegionUrlMapHttpRequest request) Runs static validation for the UrlMap.
com.google.api.gax.rpc.UnaryCallable<ValidateRegionUrlMapHttpRequest,UrlMapsValidateResponse>	validateRegionUrlMapCallable() 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

RegionUrlMapClient

protected RegionUrlMapClient(RegionUrlMapSettings settings)
                      throws IOException

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

RegionUrlMapClient

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

Method Detail

create

public static final RegionUrlMapClient create()
                                       throws IOException

Constructs an instance of RegionUrlMapClient with default settings.

Throws:

IOException

create

public static final RegionUrlMapClient create(RegionUrlMapSettings settings)
                                       throws IOException

Constructs an instance of RegionUrlMapClient, 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 RegionUrlMapClient create(RegionUrlMapStub stub)

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

getSettings

public final RegionUrlMapSettings getSettings()

getStub

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

deleteRegionUrlMap

@BetaApi
public final Operation deleteRegionUrlMap(ProjectRegionUrlMapName urlMap,
                                                   String requestId)

Deletes the specified UrlMap resource.

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   Operation response = regionUrlMapClient.deleteRegionUrlMap(urlMap, requestId);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to delete.

requestId - begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

Throws:

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

deleteRegionUrlMap

@BetaApi
public final Operation deleteRegionUrlMap(String urlMap,
                                                   String requestId)

Deletes the specified UrlMap resource.

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   Operation response = regionUrlMapClient.deleteRegionUrlMap(urlMap.toString(), requestId);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to delete.

requestId - begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

Throws:

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

deleteRegionUrlMap

@BetaApi
public final Operation deleteRegionUrlMap(DeleteRegionUrlMapHttpRequest request)

Deletes the specified UrlMap resource.

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedUrlMap = ProjectRegionUrlMapName.format("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   DeleteRegionUrlMapHttpRequest request = DeleteRegionUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setRequestId(requestId)
     .build();
   Operation response = regionUrlMapClient.deleteRegionUrlMap(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

deleteRegionUrlMapCallable

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

Deletes the specified UrlMap resource.

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedUrlMap = ProjectRegionUrlMapName.format("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   DeleteRegionUrlMapHttpRequest request = DeleteRegionUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setRequestId(requestId)
     .build();
   ApiFuture<Operation> future = regionUrlMapClient.deleteRegionUrlMapCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getRegionUrlMap

@BetaApi
public final UrlMap getRegionUrlMap(ProjectRegionUrlMapName urlMap)

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   UrlMap response = regionUrlMapClient.getRegionUrlMap(urlMap);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to return.

Throws:

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

getRegionUrlMap

@BetaApi
public final UrlMap getRegionUrlMap(String urlMap)

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   UrlMap response = regionUrlMapClient.getRegionUrlMap(urlMap.toString());
 }
 

Parameters:

urlMap - Name of the UrlMap resource to return.

Throws:

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

getRegionUrlMap

@BetaApi
public final UrlMap getRegionUrlMap(GetRegionUrlMapHttpRequest request)

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedUrlMap = ProjectRegionUrlMapName.format("[PROJECT]", "[REGION]", "[URL_MAP]");
   GetRegionUrlMapHttpRequest request = GetRegionUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .build();
   UrlMap response = regionUrlMapClient.getRegionUrlMap(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

getRegionUrlMapCallable

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

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedUrlMap = ProjectRegionUrlMapName.format("[PROJECT]", "[REGION]", "[URL_MAP]");
   GetRegionUrlMapHttpRequest request = GetRegionUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .build();
   ApiFuture<UrlMap> future = regionUrlMapClient.getRegionUrlMapCallable().futureCall(request);
   // Do something
   UrlMap response = future.get();
 }
 

insertRegionUrlMap

@BetaApi
public final Operation insertRegionUrlMap(String requestId,
                                                   ProjectRegionName region,
                                                   UrlMap urlMapResource)

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String requestId = "";
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   Operation response = regionUrlMapClient.insertRegionUrlMap(requestId, region, urlMapResource);
 }
 

Parameters:

requestId - begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

region - Name of the region scoping 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

insertRegionUrlMap

@BetaApi
public final Operation insertRegionUrlMap(String requestId,
                                                   String region,
                                                   UrlMap urlMapResource)

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String requestId = "";
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   Operation response = regionUrlMapClient.insertRegionUrlMap(requestId, region.toString(), urlMapResource);
 }
 

Parameters:

requestId - begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

region - Name of the region scoping 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

insertRegionUrlMap

@BetaApi
public final Operation insertRegionUrlMap(InsertRegionUrlMapHttpRequest request)

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String requestId = "";
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   InsertRegionUrlMapHttpRequest request = InsertRegionUrlMapHttpRequest.newBuilder()
     .setRequestId(requestId)
     .setRegion(formattedRegion)
     .setUrlMapResource(urlMapResource)
     .build();
   Operation response = regionUrlMapClient.insertRegionUrlMap(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

insertRegionUrlMapCallable

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

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String requestId = "";
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   InsertRegionUrlMapHttpRequest request = InsertRegionUrlMapHttpRequest.newBuilder()
     .setRequestId(requestId)
     .setRegion(formattedRegion)
     .setUrlMapResource(urlMapResource)
     .build();
   ApiFuture<Operation> future = regionUrlMapClient.insertRegionUrlMapCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listRegionUrlMaps

@BetaApi
public final RegionUrlMapClient.ListRegionUrlMapsPagedResponse listRegionUrlMaps(ProjectRegionName region)

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (UrlMap element : regionUrlMapClient.listRegionUrlMaps(region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

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

listRegionUrlMaps

@BetaApi
public final RegionUrlMapClient.ListRegionUrlMapsPagedResponse listRegionUrlMaps(String region)

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (UrlMap element : regionUrlMapClient.listRegionUrlMaps(region.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

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

listRegionUrlMaps

@BetaApi
public final RegionUrlMapClient.ListRegionUrlMapsPagedResponse listRegionUrlMaps(ListRegionUrlMapsHttpRequest request)

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionUrlMapsHttpRequest request = ListRegionUrlMapsHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   for (UrlMap element : regionUrlMapClient.listRegionUrlMaps(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

listRegionUrlMapsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListRegionUrlMapsHttpRequest,RegionUrlMapClient.ListRegionUrlMapsPagedResponse> listRegionUrlMapsPagedCallable()

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionUrlMapsHttpRequest request = ListRegionUrlMapsHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<ListRegionUrlMapsPagedResponse> future = regionUrlMapClient.listRegionUrlMapsPagedCallable().futureCall(request);
   // Do something
   for (UrlMap element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listRegionUrlMapsCallable

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

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionUrlMapsHttpRequest request = ListRegionUrlMapsHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   while (true) {
     UrlMapList response = regionUrlMapClient.listRegionUrlMapsCallable().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;
     }
   }
 }
 

patchRegionUrlMap

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

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionUrlMapClient.patchRegionUrlMap(urlMap, requestId, urlMapResource, fieldMask);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to patch.

requestId - begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

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

patchRegionUrlMap

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

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionUrlMapClient.patchRegionUrlMap(urlMap.toString(), requestId, urlMapResource, fieldMask);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to patch.

requestId - begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

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

patchRegionUrlMap

@BetaApi
public final Operation patchRegionUrlMap(PatchRegionUrlMapHttpRequest request)

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedUrlMap = ProjectRegionUrlMapName.format("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchRegionUrlMapHttpRequest request = PatchRegionUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setRequestId(requestId)
     .setUrlMapResource(urlMapResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = regionUrlMapClient.patchRegionUrlMap(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

patchRegionUrlMapCallable

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

Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedUrlMap = ProjectRegionUrlMapName.format("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchRegionUrlMapHttpRequest request = PatchRegionUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setRequestId(requestId)
     .setUrlMapResource(urlMapResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = regionUrlMapClient.patchRegionUrlMapCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

updateRegionUrlMap

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

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionUrlMapClient.updateRegionUrlMap(urlMap, requestId, urlMapResource, fieldMask);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to update.

requestId - begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

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

updateRegionUrlMap

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

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = regionUrlMapClient.updateRegionUrlMap(urlMap.toString(), requestId, urlMapResource, fieldMask);
 }
 

Parameters:

urlMap - Name of the UrlMap resource to update.

requestId - begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

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

updateRegionUrlMap

@BetaApi
public final Operation updateRegionUrlMap(UpdateRegionUrlMapHttpRequest request)

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedUrlMap = ProjectRegionUrlMapName.format("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateRegionUrlMapHttpRequest request = UpdateRegionUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setRequestId(requestId)
     .setUrlMapResource(urlMapResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = regionUrlMapClient.updateRegionUrlMap(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

updateRegionUrlMapCallable

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

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

Sample code:

 try (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedUrlMap = ProjectRegionUrlMapName.format("[PROJECT]", "[REGION]", "[URL_MAP]");
   String requestId = "";
   UrlMap urlMapResource = UrlMap.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   UpdateRegionUrlMapHttpRequest request = UpdateRegionUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setRequestId(requestId)
     .setUrlMapResource(urlMapResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = regionUrlMapClient.updateRegionUrlMapCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

validateRegionUrlMap

@BetaApi
public final UrlMapsValidateResponse validateRegionUrlMap(ProjectRegionUrlMapName urlMap,
                                                                   RegionUrlMapsValidateRequest regionUrlMapsValidateRequestResource)

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 (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   RegionUrlMapsValidateRequest regionUrlMapsValidateRequestResource = RegionUrlMapsValidateRequest.newBuilder().build();
   UrlMapsValidateResponse response = regionUrlMapClient.validateRegionUrlMap(urlMap, regionUrlMapsValidateRequestResource);
 }
 

Parameters:

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

regionUrlMapsValidateRequestResource -

Throws:

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

validateRegionUrlMap

@BetaApi
public final UrlMapsValidateResponse validateRegionUrlMap(String urlMap,
                                                                   RegionUrlMapsValidateRequest regionUrlMapsValidateRequestResource)

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 (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   ProjectRegionUrlMapName urlMap = ProjectRegionUrlMapName.of("[PROJECT]", "[REGION]", "[URL_MAP]");
   RegionUrlMapsValidateRequest regionUrlMapsValidateRequestResource = RegionUrlMapsValidateRequest.newBuilder().build();
   UrlMapsValidateResponse response = regionUrlMapClient.validateRegionUrlMap(urlMap.toString(), regionUrlMapsValidateRequestResource);
 }
 

Parameters:

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

regionUrlMapsValidateRequestResource -

Throws:

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

validateRegionUrlMap

@BetaApi
public final UrlMapsValidateResponse validateRegionUrlMap(ValidateRegionUrlMapHttpRequest 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 (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedUrlMap = ProjectRegionUrlMapName.format("[PROJECT]", "[REGION]", "[URL_MAP]");
   RegionUrlMapsValidateRequest regionUrlMapsValidateRequestResource = RegionUrlMapsValidateRequest.newBuilder().build();
   ValidateRegionUrlMapHttpRequest request = ValidateRegionUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setRegionUrlMapsValidateRequestResource(regionUrlMapsValidateRequestResource)
     .build();
   UrlMapsValidateResponse response = regionUrlMapClient.validateRegionUrlMap(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

validateRegionUrlMapCallable

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

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 (RegionUrlMapClient regionUrlMapClient = RegionUrlMapClient.create()) {
   String formattedUrlMap = ProjectRegionUrlMapName.format("[PROJECT]", "[REGION]", "[URL_MAP]");
   RegionUrlMapsValidateRequest regionUrlMapsValidateRequestResource = RegionUrlMapsValidateRequest.newBuilder().build();
   ValidateRegionUrlMapHttpRequest request = ValidateRegionUrlMapHttpRequest.newBuilder()
     .setUrlMap(formattedUrlMap)
     .setRegionUrlMapsValidateRequestResource(regionUrlMapsValidateRequestResource)
     .build();
   ApiFuture<UrlMapsValidateResponse> future = regionUrlMapClient.validateRegionUrlMapCallable().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