Package org.jclouds.googlecomputeengine.features

Interface TargetHttpProxyApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TargetHttpProxyApi.TargetHttpProxyPages

Method Summary

Modifier and Type	Method	Description
Operation	create(String name, URI urlMap)	Creates a targetHttpProxy resource in the specified project using the given URI for the urlMap.
Operation	create(TargetHttpProxyOptions targetHttpProxyOptions)	Creates a TargetHttpProxy resource in the specified project using the data included in the request.
Operation	delete(String targetHttpProxyName)	Deletes the specified image resource.
TargetHttpProxy	get(String targetHttpProxyName)	Returns the specified target http proxy resource.
Iterator<ListPage<TargetHttpProxy>>	list()
Iterator<ListPage<TargetHttpProxy>>	list(ListOptions listOptions)
ListPage<TargetHttpProxy>	listPage(String pageToken, ListOptions listOptions)	Retrieves the list of targetHttpProxy resources available to the specified project.
Operation	setUrlMap(String targetHttpProxyName, URI urlMap)	Updates the specified targetHttpProxy resource with the data included in the request.

Method Detail

get

@Named("TargetHttpProxys:get")
@GET
@Path("/global/targetHttpProxies/{targetHttpProxy}")
@Nullable
TargetHttpProxy get(@PathParam("targetHttpProxy")
                    String targetHttpProxyName)

Returns the specified target http proxy resource.

Parameters:

targetHttpProxyName - name of the targetHttpProxy resource to return.

Returns:

an TargetHttpProxy resource.

create

@Named("TargetHttpProxys:insert")
@POST
@Produces("application/json")
@Path("/global/targetHttpProxies")
Operation create(TargetHttpProxyOptions targetHttpProxyOptions)

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

Parameters:

targetHttpProxyOptions - the options of the targetHttpProxy 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("TargetHttpProxys:insert")
@POST
@Produces("application/json")
@Path("/global/targetHttpProxies")
Operation create(String name,
                 URI urlMap)

Creates a targetHttpProxy resource in the specified project using the given URI for the urlMap.

Parameters:

name - the name of the targetHttpProxy to be inserted.

urlMap - URI of the urlMap this proxy points to.

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.

setUrlMap

@Named("TargetHttpProxys:setUrlMap")
@POST
@Produces("application/json")
@Path("targetHttpProxies/{targetHttpProxy}/setUrlMap")
Operation setUrlMap(@PathParam("targetHttpProxy")
                    String targetHttpProxyName,
                    URI urlMap)

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

Parameters:

targetHttpProxyName - the name targetHttpProxy to be updated.

urlMap - the new url map this target http proxy points to.

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("TargetHttpProxys:delete")
@DELETE
@Path("/global/targetHttpProxies/{targetHttpProxy}")
Operation delete(@PathParam("targetHttpProxy")
                 String targetHttpProxyName)

Deletes the specified image resource.

Parameters:

targetHttpProxyName - name of the targetHttpProxy 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.

listPage

@Named("TargetHttpProxys:list")
@GET
@Path("/global/targetHttpProxies")
ListPage<TargetHttpProxy> listPage(@Nullable @QueryParam("pageToken")
                                   String pageToken,
                                   ListOptions listOptions)

Retrieves the list of targetHttpProxy 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("TargetHttpProxys:list")
@GET
@Path("/global/targetHttpProxies")
Iterator<ListPage<TargetHttpProxy>> list()

See Also:

listPage(String, ListOptions)

list

@Named("TargetHttpProxys:list")
@GET
@Path("/global/targetHttpProxies")
Iterator<ListPage<TargetHttpProxy>> list(ListOptions listOptions)

See Also:

listPage(String, ListOptions)