com.microsoft.azure.arm.collection.SupportsListingByRegion Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-arm-client-runtime Show documentation

This package contains the ARM runtime for AutoRest generated Azure Java clients.

There is a newer version: 1.7.14

Show newest version

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */

package com.microsoft.azure.arm.collection;

import com.microsoft.azure.PagedList;
import com.microsoft.azure.arm.resources.Region;
import com.microsoft.azure.management.apigeneration.LangDefinition;
import com.microsoft.azure.management.apigeneration.LangDefinition.MethodConversion;
import rx.Observable;

/**
 * Provides access to listing Azure resources of a specific type based on their region.
 * 
 * (Note: this interface is not intended to be implemented by user code)
 *
 * @param  the fluent type of the resource
 */
@LangDefinition(ContainerName = "CollectionActions", MethodConversionType = MethodConversion.OnlyMethod)
public interface SupportsListingByRegion {
    /**
     * Lists all the resources of the specified type in the specified region.
     *
     * @param region the selected Azure region
     * @return list of resources
     */
    PagedList listByRegion(Region region);

    /**
     * List all the resources of the specified type in the specified region.
     * @param regionName the name of an Azure region
     * @return list of resources
     */
    PagedList listByRegion(String regionName);

    /**
     * Lists all the resources of the specified type in the specified region.
     *
     * @param region the selected Azure region
     * @return a representation of the deferred computation of this call, returning the requested resources
     */
    Observable listByRegionAsync(Region region);

    /**
     * List all the resources of the specified type in the specified region.
     * @param regionName the name of an Azure region
     * @return a representation of the deferred computation of this call, returning the requested resources
     */
    Observable listByRegionAsync(String regionName);
}