Interface AddressApi


@Path("/addresses") @Consumes("application/json") public interface AddressApi
  • Method Details

    • get

      @Named("Addresses:get") @GET @Path("/{address}") @Nullable Address get(@PathParam("address") String address)
      Returns an address by name or null if not found.
    • create

      @Named("Addresses:insert") @POST @Produces("application/json") Operation create(String address)
      Creates an address resource in the specified project specifying the size of the address.
      Parameters:
      address - the name of address.
      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.
    • create

      @Named("Addresses:insert") @POST @Produces("application/json") Operation create(AddressCreationOptions options)
      See Also:
    • delete

      @Named("Addresses:delete") @DELETE @Path("/{address}") @Nullable Operation delete(@PathParam("address") String address)
      Deletes an address by name and returns the operation in progress, or null if not found.
    • listPage

      @Named("Addresses:list") @GET ListPage<Address> listPage(@Nullable @QueryParam("pageToken") String pageToken, ListOptions listOptions)
      Retrieves the list of address 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("Addresses:list") @GET Iterator<ListPage<Address>> list()
      See Also:
    • list

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