com.microsoft.windowsazure.serviceruntime.Role Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of microsoft-windowsazure-api Show documentation

API for Microsoft Windows Azure Clients

There is a newer version: 0.4.6

Show newest version

/**
 * Copyright Microsoft Corporation
 * 
 * Licensed 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 com.microsoft.windowsazure.serviceruntime;

import java.util.Map;

/**
 * Represents a role that is defined as part of a hosted service.
 */
public final class Role {
    private final String name;
    private final Map instances;

    /**
     * Constructor
     * 
     * @param name
     * @param instances
     */
    Role(String name, Map instances) {
        this.name = name;
        this.instances = instances;
    }

    /**
     * Returns the collection of instances for the role.
     * 
     * The number of instances of a role to be deployed to Windows Azure is specified in the service's configuration
     * file.
     * 
     * A role must define at least one internal endpoint in order for its set of instances to be known at runtime.
     * 
     * @return A read-only java.util.Map object that contains the
     *         instances for the role, or null if the instances
     *         could not be retrieved.
     */
    public Map getInstances() {
        return instances;
    }

    /**
     * Returns the name of the role as it is declared in the service definition
     * file.
     * 
     * @return A String object that represents the name of the role
     *         as it is declared in the service definition file.
     */
    public String getName() {
        return name;
    }
}