Package org.jclouds.googlecomputeengine.features

Interface BackendServiceApi

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

  • Method Details

    • get

      @Named("BackendServices:get") @GET @Path("/{backendService}") @Nullable BackendService get(@PathParam("backendService") String backendServiceName)
      Returns the specified backend service resource.
      Parameters:
      backendServiceName - name of the backend service resource to return.
      Returns:
      a BackendService resource.

    • create

      @Named("BackendServices:insert") @POST @Produces("application/json") Operation create(BackendServiceOptions backendService)
      Creates a backend service resource in the specified project using the data included in the request.
      Parameters:
      backendService - options for this backend service.
      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("BackendServices:update") @PUT @Produces("application/json") @Path("/{backendService}") Operation update(@PathParam("backendService") String backendServiceName, BackendServiceOptions backendServiceOptions)
      Updates the specified backend service resource with the data included in the request.
      Parameters:
      backendServiceName - the name backend service to be updated.
      backendServiceOptions - the new backend service.
      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("BackendServices:patch") @Produces("application/json") @Path("/{backendService}") Operation patch(@PathParam("backendService") String backendServiceName, BackendServiceOptions backendServiceOptions)
      Updates the specified backend service resource, with patch semantics, with the data included in the request.
      Parameters:
      backendServiceName - the name backend service to be updated.
      backendServiceOptions - the new backend service.
      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("BackendServices:getHealth") @POST @Produces("application/json") @Path("/{backendService}/getHealth") HealthStatus getHealth(@PathParam("backendService") String backendServiceName, URI group)
      Gets the most recent health check results for this backend service. Note that health check results will only be returned if the backend service has a valid global forwarding rule referencing it.
      Parameters:
      backendServiceName - the name backend service to get health stats on.
      group - the group in the backend service to get health stats on.
      Returns:
      a BackendServiceGroupHealth resource denoting the health states of instances in the specified group.

    • delete

      @Named("BackendServices:delete") @DELETE @Path("/{backendService}") Operation delete(@PathParam("backendService") String backendServiceName)
      Deletes the specified backend service resource.
      Parameters:
      backendServiceName - name of the backend service 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.

    • listPage

      @Named("BackendServices:list") @GET ListPage<BackendService> listPage(@QueryParam("pageToken") @Nullable String pageToken, ListOptions options)
      Retrieves the list of backend service 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("BackendServices:list") @GET Iterator<ListPage<BackendService>> list()
      See Also:

    • list

      @Named("BackendServices:list") @GET Iterator<ListPage<BackendService>> list(ListOptions options)
      See Also: