Method Detail

• get

  @Named(value="BackendServices:get")
  @GET
  @Path(value="/{backendService}")
  @Nullable
  BackendService get(@PathParam(value="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(value="BackendServices:insert")
  @POST
  @Produces(value="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(value="BackendServices:update")
  @PUT
  @Produces(value="application/json")
  @Path(value="/{backendService}")
  Operation update(@PathParam(value="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(value="BackendServices:patch")
  @Produces(value="application/json")
  @Path(value="/{backendService}")
  Operation patch(@PathParam(value="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(value="BackendServices:getHealth")
  @POST
  @Produces(value="application/json")
  @Path(value="/{backendService}/getHealth")
  HealthStatus getHealth(@PathParam(value="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(value="BackendServices:delete")
  @DELETE
  @Path(value="/{backendService}")
  Operation delete(@PathParam(value="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(value="BackendServices:list")
  @GET
  ListPage<BackendService> listPage(@QueryParam(value="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(value="BackendServices:list")
  @GET
  Iterator<ListPage<BackendService>> list()

  See Also:

  listPage(String, ListOptions)

• list

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

  See Also:

  listPage(String, ListOptions)