Interface HttpHealthCheckApi
@Path("/httpHealthChecks")
@Consumes("application/json")
public interface HttpHealthCheckApi
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionDeletes a health check by name and returns the operation in progress, or null if not found.Returns a health check by name or null if not found.Creates a HttpHealthCheck resource in the specified project and region using the data included in the request.insert
(String name, HttpHealthCheckCreationOptions options) Creates a HttpHealthCheck resource in the specified project and region using the data included in the request.list()
list
(ListOptions options) listPage
(String pageToken, ListOptions listOptions) Retrieves the list of persistent http health check resources available to the specified project.patch
(String name, HttpHealthCheckCreationOptions options) Updates a HttpHealthCheck resource in the specified project using the data included in the request.update
(String name, HttpHealthCheckCreationOptions options) Updates a HttpHealthCheck resource in the specified project using the data included in the request.
-
Method Details
-
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 pagelistOptions
- listing options- Returns:
- a page of the list
-
list
- See Also:
-
list
- See Also:
-