target.apidocs.com.google.api.services.compute.Compute.UrlMaps.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250320-2.0.0

Show newest version







Compute.UrlMaps (Compute Engine API v1-rev20250107-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute
Class Compute.UrlMaps



java.lang.Object


com.google.api.services.compute.Compute.UrlMaps







Enclosing class:
Compute




public class Compute.UrlMaps
extends Object
The "urlMaps" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Compute.UrlMaps.AggregatedList 


class 
Compute.UrlMaps.Delete 


class 
Compute.UrlMaps.Get 


class 
Compute.UrlMaps.Insert 


class 
Compute.UrlMaps.InvalidateCache 


class 
Compute.UrlMaps.List 


class 
Compute.UrlMaps.Patch 


class 
Compute.UrlMaps.Update 


class 
Compute.UrlMaps.Validate 









Constructor Summary

Constructors 

Constructor and Description


UrlMaps() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Compute.UrlMaps.AggregatedList
aggregatedList(String project)
Retrieves the list of all UrlMap resources, regional and global, available to the specified
 project.



Compute.UrlMaps.Delete
delete(String project,
      String urlMap)
Deletes the specified UrlMap resource.



Compute.UrlMaps.Get
get(String project,
   String urlMap)
Returns the specified UrlMap resource.



Compute.UrlMaps.Insert
insert(String project,
      UrlMap content)
Creates a UrlMap resource in the specified project using the data included in the request.



Compute.UrlMaps.InvalidateCache
invalidateCache(String project,
               String urlMap,
               CacheInvalidationRule content)
Initiates a cache invalidation operation, invalidating the specified path, scoped to the
 specified UrlMap.



Compute.UrlMaps.List
list(String project)
Retrieves the list of UrlMap resources available to the specified project.



Compute.UrlMaps.Patch
patch(String project,
     String urlMap,
     UrlMap content)
Patches the specified UrlMap resource with the data included in the request.



Compute.UrlMaps.Update
update(String project,
      String urlMap,
      UrlMap content)
Updates the specified UrlMap resource with the data included in the request.



Compute.UrlMaps.Validate
validate(String project,
        String urlMap,
        UrlMapsValidateRequest content)
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





UrlMaps
public UrlMaps()









Method Detail





aggregatedList
public Compute.UrlMaps.AggregatedList aggregatedList(String project)
                                              throws IOException
Retrieves the list of all UrlMap resources, regional and global, available to the specified
 project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter
 to `true`.

 Create a request for the method "urlMaps.aggregatedList".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Name of the project scoping this request.
Returns:
the request
Throws:
IOException








delete
public Compute.UrlMaps.Delete delete(String project,
                                     String urlMap)
                              throws IOException
Deletes the specified UrlMap resource.

 Create a request for the method "urlMaps.delete".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
urlMap - Name of the UrlMap resource to delete.
Returns:
the request
Throws:
IOException








get
public Compute.UrlMaps.Get get(String project,
                               String urlMap)
                        throws IOException
Returns the specified UrlMap resource.

 Create a request for the method "urlMaps.get".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
urlMap - Name of the UrlMap resource to return.
Returns:
the request
Throws:
IOException








insert
public Compute.UrlMaps.Insert insert(String project,
                                     UrlMap content)
                              throws IOException
Creates a UrlMap resource in the specified project using the data included in the request.

 Create a request for the method "urlMaps.insert".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
content - the UrlMap
Returns:
the request
Throws:
IOException








invalidateCache
public Compute.UrlMaps.InvalidateCache invalidateCache(String project,
                                                       String urlMap,
                                                       CacheInvalidationRule content)
                                                throws IOException
Initiates a cache invalidation operation, invalidating the specified path, scoped to the
 specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-
 cached-content).

 Create a request for the method "urlMaps.invalidateCache".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
urlMap - Name of the UrlMap scoping this request.
content - the CacheInvalidationRule
Returns:
the request
Throws:
IOException








list
public Compute.UrlMaps.List list(String project)
                          throws IOException
Retrieves the list of UrlMap resources available to the specified project.

 Create a request for the method "urlMaps.list".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
Returns:
the request
Throws:
IOException








patch
public Compute.UrlMaps.Patch patch(String project,
                                   String urlMap,
                                   UrlMap content)
                            throws IOException
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.

 Create a request for the method "urlMaps.patch".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
urlMap - Name of the UrlMap resource to patch.
content - the UrlMap
Returns:
the request
Throws:
IOException








update
public Compute.UrlMaps.Update update(String project,
                                     String urlMap,
                                     UrlMap content)
                              throws IOException
Updates the specified UrlMap resource with the data included in the request.

 Create a request for the method "urlMaps.update".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
urlMap - Name of the UrlMap resource to update.
content - the UrlMap
Returns:
the request
Throws:
IOException








validate
public Compute.UrlMaps.Validate validate(String project,
                                         String urlMap,
                                         UrlMapsValidateRequest content)
                                  throws IOException
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.

 Create a request for the method "urlMaps.validate".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
urlMap - Name of the UrlMap resource to be validated as.
content - the UrlMapsValidateRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Compute.UrlMaps.AggregatedList`
`class`	`Compute.UrlMaps.Delete`
`class`	`Compute.UrlMaps.Get`
`class`	`Compute.UrlMaps.Insert`
`class`	`Compute.UrlMaps.InvalidateCache`
`class`	`Compute.UrlMaps.List`
`class`	`Compute.UrlMaps.Patch`
`class`	`Compute.UrlMaps.Update`
`class`	`Compute.UrlMaps.Validate`

Modifier and Type	Method and Description
`Compute.UrlMaps.AggregatedList`	`aggregatedList(String project)` Retrieves the list of all UrlMap resources, regional and global, available to the specified project.
`Compute.UrlMaps.Delete`	`delete(String project, String urlMap)` Deletes the specified UrlMap resource.
`Compute.UrlMaps.Get`	`get(String project, String urlMap)` Returns the specified UrlMap resource.
`Compute.UrlMaps.Insert`	`insert(String project, UrlMap content)` Creates a UrlMap resource in the specified project using the data included in the request.
`Compute.UrlMaps.InvalidateCache`	`invalidateCache(String project, String urlMap, CacheInvalidationRule content)` Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.
`Compute.UrlMaps.List`	`list(String project)` Retrieves the list of UrlMap resources available to the specified project.
`Compute.UrlMaps.Patch`	`patch(String project, String urlMap, UrlMap content)` Patches the specified UrlMap resource with the data included in the request.
`Compute.UrlMaps.Update`	`update(String project, String urlMap, UrlMap content)` Updates the specified UrlMap resource with the data included in the request.
`Compute.UrlMaps.Validate`	`validate(String project, String urlMap, UrlMapsValidateRequest content)` Runs static validation for the UrlMap.