Package org.jclouds.googlecomputeengine.features

Interface UrlMapApi

@Consumes("application/json")
public interface UrlMapApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UrlMapApi.UrlMapPages

Method Summary

Modifier and Type	Method	Description
Operation	create(String name, URI defaultService)	Creates a urlMap resource in the specified project using the data included in the request.
Operation	create(UrlMapOptions urlMapOptions)	Creates a urlMap resource in the specified project using the data included in the request.
Operation	delete(String urlMapName)	Deletes the specified urlMap resource.
UrlMap	get(String urlMapName)	Returns the specified urlMap resource by name or null if not found.
Iterator<ListPage<UrlMap>>	list()
Iterator<ListPage<UrlMap>>	list(ListOptions options)
ListPage<UrlMap>	listPage(String pageToken, ListOptions listOptions)	Retrieves the list of urlMap resources available to the specified project.
Operation	patch(String urlMapName, UrlMapOptions urlMapOptions)	Updates the specified urlMap resource, with patch semantics, with the data included in the request.
Operation	update(String urlMapName, UrlMapOptions urlMapOptions)	Updates the specified urlMap resource with the data included in the request.
UrlMapValidateResult	validate(String urlMapName, UrlMap urlMap)	Runs the tests specified for the give urlMap resource.
UrlMapValidateResult	validate(String urlMapName, UrlMapOptions options)	Runs the tests specified for the give urlMap resource.

Method Detail

get

@Named("UrlMaps:get")
@GET
@Path("/{urlMap}")
@Nullable
UrlMap get(@PathParam("urlMap")
           String urlMapName)

Returns the specified urlMap resource by name or null if not found.

create

@Named("UrlMaps:insert")
@POST
@Produces("application/json")
Operation create(UrlMapOptions urlMapOptions)

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

Parameters:

urlMapOptions - the options of the urlMap to add.

Returns:

an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

create

@Named("UrlMaps:insert")
@POST
@Produces("application/json")
Operation create(String name,
                 URI defaultService)

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

Parameters:

name - the name of the urlMap to be inserted.

defaultService - the default backend service of the urlMap to add.

Returns:

an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

update

@Named("UrlMaps:update")
@PUT
@Produces("application/json")
@Path("/{urlMap}")
Operation update(@PathParam("urlMap")
                 String urlMapName,
                 UrlMapOptions urlMapOptions)

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

Parameters:

urlMapName - the name urlMap to be updated.

urlMapOptions - the new urlMap options.

Returns:

an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

patch

@Named("UrlMaps:patch")
@Produces("application/json")
@Path("/{urlMap}")
Operation patch(@PathParam("urlMap")
                String urlMapName,
                UrlMapOptions urlMapOptions)

Updates the specified urlMap resource, with patch semantics, with the data included in the request. Note:UrlMapOptions.Builder.buildForPatch() may be helpful.

Parameters:

urlMapName - the name urlMap to be updated.

urlMapOptions - the new urlMap options.

Returns:

an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

delete

@Named("UrlMaps:delete")
@DELETE
@Path("/{urlMap}")
Operation delete(@PathParam("urlMap")
                 String urlMapName)

Deletes the specified urlMap resource.

Parameters:

urlMapName - name of the urlMap resource to delete.

Returns:

an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field. If the image did not exist the result is null.

validate

@Named("UrlMaps:validate")
@POST
@Path("/{urlMap}/validate")
@Nullable
UrlMapValidateResult validate(@PathParam("urlMap")
                              String urlMapName,
                              UrlMapOptions options)

Runs the tests specified for the give urlMap resource.

Parameters:

urlMapName - name of the urlMap to run tests on.

options - options that represent the url map to be tested.

Returns:

the result of the tests for the given urlMap resource.

validate

@Named("UrlMaps:validate")
@POST
@Path("/{urlMap}/validate")
@Nullable
UrlMapValidateResult validate(@PathParam("urlMap")
                              String urlMapName,
                              UrlMap urlMap)

Runs the tests specified for the give urlMap resource.

Parameters:

urlMapName - name of the urlMap to run tests on.

urlMap - the url map to be tested.

Returns:

the result of the tests for the given urlMap resource.

listPage

@Named("UrlMaps:list")
@GET
ListPage<UrlMap> listPage(@Nullable @QueryParam("pageToken")
                          String pageToken,
                          ListOptions listOptions)

Retrieves the list of urlMap resources available to the specified project. By default the list as a maximum size of 100, if no options are provided or ListOptions#getMaxResults() has not been set.

Parameters:

pageToken - marks the beginning of the next list page

listOptions - listing options

Returns:

a page of the list

list

@Named("UrlMaps:list")
@GET
Iterator<ListPage<UrlMap>> list()

See Also:

#listPage(String, String, ListOptions)

list

@Named("UrlMaps:list")
@GET
Iterator<ListPage<UrlMap>> list(ListOptions options)

See Also:

#listPage(String, String, ListOptions)