TargetPoolApi (Apache jclouds 2.1.0 API)

@Path(value="/targetPools")
@Consumes(value="application/json")
public interface TargetPoolApi

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class TargetPoolApi.TargetPoolPages

Nested Classes
Modifier and Type	Interface and Description
`static class`	`TargetPoolApi.TargetPoolPages`

Method Summary

Methods
Modifier and Type	Method and Description
`Operation`	`addHealthCheck(String targetPool, List<URI> healthChecks)` Adds health check URL to targetPool.
`Operation`	`addInstance(String targetPool, List<URI> instances)` Adds instance to the targetPool.
`Operation`	`create(TargetPoolCreationOptions options)` Creates a TargetPool resource in the specified project and region using the data included in the request.
`Operation`	`delete(String targetPool)` Deletes a target pool by name and returns the operation in progress, or null if not found.
`TargetPool`	`get(String targetPool)` Returns a target pool by name or null if not found.
`HealthStatus`	`getHealth(String targetPool, URI instance)` Gets the HealthStatus of an instance in a targetPool.
`Iterator<ListPage<TargetPool>>`	`list()`
`Iterator<ListPage<TargetPool>>`	`list(ListOptions options)`
`ListPage<TargetPool>`	`listPage(String pageToken, ListOptions listOptions)` Retrieves the list of target pool resources available to the specified project.
`Operation`	`removeHealthCheck(String targetPool, List<URI> healthChecks)` Removes health check URL from targetPool.
`Operation`	`removeInstance(String targetPool, List<URI> instances)` Removes instance URL from targetPool.
`Operation`	`setBackup(String targetPool, Float failoverRatio, URI target)` Changes backup pool configurations.
`Operation`	`setBackup(String targetPool, URI target)` Changes backup pool configurations.

Method Detail

get

@Named(value="TargetPools:get")
@GET
@Path(value="/{targetPool}")
@Nullable
TargetPool get(@PathParam(value="targetPool")
                                     String targetPool)

Returns a target pool by name or null if not found.

create
```
@Named(value="TargetPools:insert")
@POST
@Produces(value="application/json")
Operation create(TargetPoolCreationOptions options)
```
Creates a TargetPool resource in the specified project and region using the data included in the request.

Parameters:
name - the name of the targetPool.
options - options of the TargetPool to create.

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(value="TargetPools:delete")
@DELETE
@Path(value="/{targetPool}")
@Nullable
Operation delete(@PathParam(value="targetPool")
                                          String targetPool)

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

addInstance

@Named(value="TargetPools:addInstance")
@POST
@Path(value="/{targetPool}/addInstance")
Operation addInstance(@PathParam(value="targetPool")
                                    String targetPool,
                                    List<URI> instances)

Adds instance to the targetPool.

Parameters:: targetPool - the name of the target pool.; instances - the self-links of the instances to be added to targetPool.
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.

removeInstance

@Named(value="TargetPools:removeInstance")
@POST
@Path(value="/{targetPool}/removeInstance")
Operation removeInstance(@PathParam(value="targetPool")
                                       String targetPool,
                                       List<URI> instances)

Removes instance URL from targetPool.

Parameters:: targetPool - the name of the target pool.; instances - the self-links of the instances to be removed from the targetPool.
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.

addHealthCheck

@Named(value="TargetPools:addHealthCheck")
@POST
@Path(value="/{targetPool}/addHealthCheck")
Operation addHealthCheck(@PathParam(value="targetPool")
                                       String targetPool,
                                       List<URI> healthChecks)

Adds health check URL to targetPool.

Parameters:: targetPool - the name of the target pool.; healthChecks - the self-links of the health checks to be added to targetPool.
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.

removeHealthCheck

@Named(value="TargetPools:removeHealthCheck")
@POST
@Path(value="/{targetPool}/removeHealthCheck")
Operation removeHealthCheck(@PathParam(value="targetPool")
                                          String targetPool,
                                          List<URI> healthChecks)

Removes health check URL from targetPool.

Parameters:: targetPool - the name of the target pool.; healthChecks - the self-links of the health checks to be removed from the targetPool.
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.

getHealth
```
@Named(value="TargetPools:getHealth")
@POST
@Path(value="/{targetPool}/getHealth")
HealthStatus getHealth(@PathParam(value="targetPool")
                                     String targetPool,
                                     URI instance)
```
Gets the HealthStatus of an instance in a targetPool.

Parameters:
targetPool - the name of the target pool.
healthChecks - the self-links of the health checks to be removed from the targetPool.

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.

setBackup
```
@Named(value="TargetPools:setBackup")
@POST
@Path(value="/{targetPool}/setBackup")
@Nullable
Operation setBackup(@PathParam(value="targetPool")
                                           String targetPool,
                                           URI target)
```
Changes backup pool configurations.

Parameters:
targetPool - the name of the target pool.
target - the URL of target pool for which you want to use as backup. WARNING: failoverRatio and BackupPool must either both be set or not set. This method is only for updating the backup pool on a Target Pool that already has a failoverRatio.

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.

setBackup

@Named(value="TargetPools:setBackup")
@POST
@Path(value="/{targetPool}/setBackup")
@Nullable
Operation setBackup(@PathParam(value="targetPool")
                                           String targetPool,
                                           @QueryParam(value="failoverRatio")
                                           Float failoverRatio,
                                           URI target)

Changes backup pool configurations.

Parameters:: targetPool - the name of the target pool.; target - the URL of target pool for which you want to use as backup.
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(value="TargetPools:list")
@GET
ListPage<TargetPool> listPage(@Nullable@QueryParam(value="pageToken")
                                      String pageToken,
                                      ListOptions listOptions)
```
Retrieves the list of target pool 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(value="TargetPools:list")
@GET
Iterator<ListPage<TargetPool>> list()

See Also:: listPage(String, ListOptions)

list

@Named(value="TargetPools:list")
@GET
Iterator<ListPage<TargetPool>> list(ListOptions options)

See Also:: listPage(String, ListOptions)

Interface TargetPoolApi

Nested Class Summary

Method Summary

Method Detail

get

create

delete

addInstance

removeInstance

addHealthCheck

removeHealthCheck

getHealth

setBackup

setBackup

listPage

list

list