org.jclouds.cloudstack.options.ListSecurityGroupsOptions.java Source code

Introduction

Here is the source code for org.jclouds.cloudstack.options.ListSecurityGroupsOptions.java

Source

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jclouds.cloudstack.options;

import com.google.common.collect.ImmutableSet;

/**
 * Options used to control what security groups are returned
 * 
 * @see <a href=
 *      "http://download.cloud.com/releases/2.2.0/api/user/listSecurityGroups.html"
 *      />
 * @author Adrian Cole
 */
public class ListSecurityGroupsOptions extends AssociateIPAddressOptions {

    public static final ListSecurityGroupsOptions NONE = new ListSecurityGroupsOptions();

    /**
     * @param id
     *           the ID of the security group
     */
    public ListSecurityGroupsOptions id(String id) {
        this.queryParameters.replaceValues("id", ImmutableSet.of(id + ""));
        return this;
    }

    /**
     * @param securityGroupName
     *           lists security groups by name
     */
    public ListSecurityGroupsOptions named(String securityGroupName) {
        this.queryParameters.replaceValues("securitygroupname", ImmutableSet.of(securityGroupName));
        return this;
    }

    /**
     * @param virtualMachineId
     *           the ID of the virtual machine. Pass this in if you want to see
     *           the available service offering that a virtual machine can be
     *           changed to.
     */
    public ListSecurityGroupsOptions virtualMachineId(String virtualMachineId) {
        this.queryParameters.replaceValues("virtualmachineid", ImmutableSet.of(virtualMachineId + ""));
        return this;

    }

    public static class Builder {

        /**
         * @see ListSecurityGroupsOptions#named
         */
        public static ListSecurityGroupsOptions named(String securityGroupName) {
            ListSecurityGroupsOptions options = new ListSecurityGroupsOptions();
            return options.named(securityGroupName);
        }

        /**
         * @see ListSecurityGroupsOptions#id
         */
        public static ListSecurityGroupsOptions id(String id) {
            ListSecurityGroupsOptions options = new ListSecurityGroupsOptions();
            return options.id(id);
        }

        /**
         * @see ListSecurityGroupsOptions#virtualMachineId
         */
        public static ListSecurityGroupsOptions virtualMachineId(String virtualMachineId) {
            ListSecurityGroupsOptions options = new ListSecurityGroupsOptions();
            return options.virtualMachineId(virtualMachineId);
        }

        /**
         * @see DeployVirtualMachineOptions#accountInDomain
         */
        public static ListSecurityGroupsOptions accountInDomain(String account, String domain) {
            ListSecurityGroupsOptions options = new ListSecurityGroupsOptions();
            return options.accountInDomain(account, domain);
        }

        /**
         * @see DeployVirtualMachineOptions#domainId
         */
        public static ListSecurityGroupsOptions domainId(String domainId) {
            ListSecurityGroupsOptions options = new ListSecurityGroupsOptions();
            return options.domainId(domainId);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public ListSecurityGroupsOptions accountInDomain(String account, String domain) {
        return ListSecurityGroupsOptions.class.cast(super.accountInDomain(account, domain));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public ListSecurityGroupsOptions domainId(String domainId) {
        return ListSecurityGroupsOptions.class.cast(super.domainId(domainId));
    }
}