Package org.jclouds.googlecomputeengine.features

Interface HttpHealthCheckApi

@Path("/httpHealthChecks")
@Consumes("application/json")
public interface HttpHealthCheckApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HttpHealthCheckApi.HttpHealthCheckPages

Method Summary

Modifier and Type	Method	Description
Operation	delete(String httpHealthCheck)	Deletes a health check by name and returns the operation in progress, or null if not found.
HttpHealthCheck	get(String httpHealthCheck)	Returns a health check by name or null if not found.
Operation	insert(String httpHealthCheckName)	Creates a HttpHealthCheck resource in the specified project and region using the data included in the request.
Operation	insert(String name, HttpHealthCheckCreationOptions options)	Creates a HttpHealthCheck resource in the specified project and region using the data included in the request.
Iterator<ListPage<HttpHealthCheck>>	list()
Iterator<ListPage<HttpHealthCheck>>	list(ListOptions options)
ListPage<HttpHealthCheck>	listPage(String pageToken, ListOptions listOptions)	Retrieves the list of persistent http health check resources available to the specified project.
Operation	patch(String name, HttpHealthCheckCreationOptions options)	Updates a HttpHealthCheck resource in the specified project using the data included in the request.
Operation	update(String name, HttpHealthCheckCreationOptions options)	Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Method Detail

get

@Named("HttpHealthChecks:get")
@GET
@Path("/{httpHealthCheck}")
@Nullable
HttpHealthCheck get(@PathParam("httpHealthCheck")
                    String httpHealthCheck)

Returns a health check by name or null if not found.

insert

@Named("HttpHealthChecks:insert")
@POST
@Produces("application/json")
Operation insert(String httpHealthCheckName)

Creates a HttpHealthCheck resource in the specified project and region using the data included in the request.

Parameters:

httpHealthCheckName - the name of the forwarding rule.

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.

insert

@Named("HttpHealthChecks:insert")
@POST
@Produces("application/json")
Operation insert(String name,
                 HttpHealthCheckCreationOptions options)

Creates a HttpHealthCheck resource in the specified project and region using the data included in the request.

Parameters:

name - the name of the forwarding rule.

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("HttpHealthChecks:delete")
@DELETE
@Path("/{httpHealthCheck}")
@Nullable
Operation delete(@PathParam("httpHealthCheck")
                 String httpHealthCheck)

Deletes a health check by name and returns the operation in progress, or null if not found.

patch

@Named("HttpHealthChecks:patch")
@Path("/{httpHealthCheck}")
@Nullable
Operation patch(@PathParam("httpHealthCheck")
                String name,
                HttpHealthCheckCreationOptions options)

Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

Parameters:

name - the name of the HttpHealthCheck resource to update.

options - the options to set for the healthCheck

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("HttpHealthChecks:update")
@PUT
@Path("/{httpHealthCheck}")
@Produces("application/json")
Operation update(@PathParam("httpHealthCheck")
                 String name,
                 HttpHealthCheckCreationOptions options)

Updates a HttpHealthCheck resource in the specified project using the data included in the request. Any options left blank will be overwritten!

Parameters:

name - the name of the forwarding rule.

options - the options to set for the healthCheck

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.

listPage

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

Retrieves the list of persistent http health check 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("HttpHealthChecks:list")
@GET
Iterator<ListPage<HttpHealthCheck>> list()

See Also:

listPage(String, ListOptions)

list

@Named("HttpHealthChecks:list")
@GET
Iterator<ListPage<HttpHealthCheck>> list(ListOptions options)

See Also:

listPage(String, ListOptions)