Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
 * 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.arm.model.Creatable;
import com.microsoft.azure.arm.model.CreatedResources;
import com.microsoft.azure.arm.model.Indexable;
import com.microsoft.azure.management.apigeneration.LangDefinition;
import com.microsoft.azure.management.apigeneration.LangDefinition.MethodConversion;
import com.microsoft.rest.ServiceCallback;
import com.microsoft.rest.ServiceFuture;
import rx.Observable;

import java.util.List;

Providing access to creating a batch of Azure top level resources of same type.

(Note: this interface is not intended to be implemented by user code)
Type parameters:
<ResourceT> – the top level Azure resource type/**
 * Providing access to creating a batch of Azure top level resources of same type.
 * <p>
 * (Note: this interface is not intended to be implemented by user code)
 * @param <ResourceT> the top level Azure resource type
 */
@LangDefinition(ContainerName = "CollectionActions", MethodConversionType = MethodConversion.OnlyMethod)
public interface SupportsBatchCreation<ResourceT extends Indexable> {
    
Executes the create requests on a collection (batch) of resources.
Params:
creatables – the creatables in the batch
Returns:
the batch operation result from which created resources in this batch can be accessed./**
     * Executes the create requests on a collection (batch) of resources.
     *
     * @param creatables the creatables in the batch
     * @return the batch operation result from which created resources in this batch can be accessed.
     */
    CreatedResources<ResourceT> create(Creatable<ResourceT>... creatables);

    
Executes the create requests on a collection (batch) of resources.
Params:
creatables – the list of creatables in the batch
Returns:
the batch operation result from which created resources in this batch can be accessed./**
     * Executes the create requests on a collection (batch) of resources.
     *
     * @param creatables the list of creatables in the batch
     * @return the batch operation result from which created resources in this batch can be accessed.
     */
    CreatedResources<ResourceT> create(List<Creatable<ResourceT>> creatables);

    
Puts the requests to create a batch of resources into the queue and allow the HTTP client to execute it when
system resources are available.
Params:
creatables – the creatables in the batch
Returns:
an observable for the resources/**
     * Puts the requests to create a batch of resources into the queue and allow the HTTP client to execute it when
     * system resources are available.
     *
     * @param creatables the creatables in the batch
     * @return an observable for the resources
     */
    Observable<Indexable> createAsync(Creatable<ResourceT>... creatables);

    
Puts the requests to create a batch of resources into the queue and allow the HTTP client to execute it when
system resources are available.
Params:
creatables – the list of creatables in the batch
Returns:
an observable for the resources/**
     * Puts the requests to create a batch of resources into the queue and allow the HTTP client to execute it when
     * system resources are available.
     *
     * @param creatables the list of creatables in the batch
     * @return an observable for the resources
     */
    Observable<Indexable> createAsync(List<Creatable<ResourceT>> creatables);

    
Puts the requests to create a batch of resources into the queue and allow the HTTP client to execute it when
system resources are available.
Params:
callback – the callback to handle success and failure
creatables – the creatables in the batch
Returns:
a handle to cancel the request/**
     * Puts the requests to create a batch of resources into the queue and allow the HTTP client to execute it when
     * system resources are available.
     *
     * @param callback the callback to handle success and failure
     * @param creatables the creatables in the batch
     * @return a handle to cancel the request
     */
    ServiceFuture<CreatedResources<ResourceT>> createAsync(ServiceCallback<CreatedResources<ResourceT>> callback, Creatable<ResourceT>... creatables);

    
Puts the requests to create a batch of resources into the queue and allow the HTTP client to execute it when
system resources are available.
Params:
callback – the callback to handle success and failure
creatables – the list of creatables in the batch
Returns:
a handle to cancel the request/**
     * Puts the requests to create a batch of resources into the queue and allow the HTTP client to execute it when
     * system resources are available.
     *
     * @param callback the callback to handle success and failure
     * @param creatables the list of creatables in the batch
     * @return a handle to cancel the request
     */
    ServiceFuture<CreatedResources<ResourceT>> createAsync(ServiceCallback<CreatedResources<ResourceT>> callback, List<Creatable<ResourceT>> creatables);
}