Interface SecurityGroupApi


  • @Beta
    @Consumes("application/json")
    public interface SecurityGroupApi
    Provides access to the OpenStack Compute (Nova) Security Group extension API.
    • Method Detail

      • list

        @Named("securityGroup:list")
        @GET
        @Path("/os-security-groups")
        com.google.common.collect.FluentIterable<SecurityGroup> list()
        List all Security Groups.
        Returns:
        all Security Groups
      • get

        @Named("securityGroup:get")
        @GET
        @Path("/os-security-groups/{id}")
        @Nullable
        SecurityGroup get​(@PathParam("id")
                          String id)
        Get a specific Security Group
        Returns:
        a specific Security Group
      • createWithDescription

        @Named("securityGroup:create")
        @POST
        @Path("/os-security-groups")
        @Produces("application/json")
        @Nullable
        SecurityGroup createWithDescription​(String name,
                                            String description)
        Create a Security Group
        Returns:
        a new Security Group
      • delete

        @Named("securityGroup:delete")
        @DELETE
        @Path("/os-security-groups/{id}")
        boolean delete​(@PathParam("id")
                       String id)
        Delete a Security Group.
        Returns:
      • createRuleAllowingCidrBlock

        @Named("securityGroup:create")
        @POST
        @Path("/os-security-group-rules")
        @Produces("application/json")
        @Nullable
        SecurityGroupRule createRuleAllowingCidrBlock​(String parentGroup,
                                                      Ingress ip_protocol,
                                                      String sourceCidr)
        Create a Security Group Rule.
        Returns:
        a new Security Group Rule
      • createRuleAllowingSecurityGroupId

        @Named("securityGroup:create")
        @POST
        @Path("/os-security-group-rules")
        @Produces("application/json")
        @Nullable
        SecurityGroupRule createRuleAllowingSecurityGroupId​(String parentGroup,
                                                            Ingress ip_protocol,
                                                            String groupId)
        Create a Security Group Rule.
        Returns:
        a new Security Group Rule
      • deleteRule

        @Named("securityGroup:delete")
        @DELETE
        @Path("/os-security-group-rules/{id}")
        boolean deleteRule​(@PathParam("id")
                           String ruleId)
        Delete a Security Group Rule.
        Returns: