Applications Interface

Reference

Package:: com.microsoft.azure.batch.protocol

public interface Applications

An instance of this class provides access to all the operations defined in Applications.

Method Summary

Modifier and Type	Method and Description
ApplicationSummary	get(String applicationId) Gets information about the specified application. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
ApplicationSummary	get(String applicationId, ApplicationGetOptions applicationGetOptions) Gets information about the specified application. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<ApplicationSummary>	getAsync(String applicationId) Gets information about the specified application. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<ApplicationSummary>	getAsync(String applicationId, ApplicationGetOptions applicationGetOptions) Gets information about the specified application. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
ServiceFuture<ApplicationSummary>	getAsync(String applicationId, ApplicationGetOptions applicationGetOptions, final ServiceCallback<ApplicationSummary> serviceCallback) Gets information about the specified application. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
ServiceFuture<ApplicationSummary>	getAsync(String applicationId, final ServiceCallback<ApplicationSummary> serviceCallback) Gets information about the specified application. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<ServiceResponseWithHeaders<ApplicationSummary, ApplicationGetHeaders>>	getWithServiceResponseAsync(String applicationId) Gets information about the specified application. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<ServiceResponseWithHeaders<ApplicationSummary, ApplicationGetHeaders>>	getWithServiceResponseAsync(String applicationId, ApplicationGetOptions applicationGetOptions) Gets information about the specified application. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
PagedList<ApplicationSummary>	list() Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
PagedList<ApplicationSummary>	list(final ApplicationListOptions applicationListOptions) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<Page<ApplicationSummary>>	listAsync() Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<Page<ApplicationSummary>>	listAsync(final ApplicationListOptions applicationListOptions) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
ServiceFuture<List<ApplicationSummary>>	listAsync(final ApplicationListOptions applicationListOptions, final ListOperationCallback<ApplicationSummary> serviceCallback) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
ServiceFuture<List<ApplicationSummary>>	listAsync(final ListOperationCallback<ApplicationSummary> serviceCallback) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
PagedList<ApplicationSummary>	listNext(final String nextPageLink) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
PagedList<ApplicationSummary>	listNext(final String nextPageLink, final ApplicationListNextOptions applicationListNextOptions) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<Page<ApplicationSummary>>	listNextAsync(final String nextPageLink) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<Page<ApplicationSummary>>	listNextAsync(final String nextPageLink, final ApplicationListNextOptions applicationListNextOptions) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
ServiceFuture<List<ApplicationSummary>>	listNextAsync(final String nextPageLink, final ApplicationListNextOptions applicationListNextOptions, final ServiceFuture<List<ApplicationSummary>> serviceFuture, final ListOperationCallback<ApplicationSummary> serviceCallback) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
ServiceFuture<List<ApplicationSummary>>	listNextAsync(final String nextPageLink, final ServiceFuture<List<ApplicationSummary>> serviceFuture, final ListOperationCallback<ApplicationSummary> serviceCallback) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>, ApplicationListHeaders>>	listNextWithServiceResponseAsync(final String nextPageLink) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>, ApplicationListHeaders>>	listNextWithServiceResponseAsync(final String nextPageLink, final ApplicationListNextOptions applicationListNextOptions) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>, ApplicationListHeaders>>	listWithServiceResponseAsync() Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.
Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>, ApplicationListHeaders>>	listWithServiceResponseAsync(final ApplicationListOptions applicationListOptions) Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.

Method Details

get

public ApplicationSummary get(String applicationId)

Gets information about the specified application. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.

Parameters:

applicationId - The ID of the application.

Returns:

the ApplicationSummary object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

get

public ApplicationSummary get(String applicationId, ApplicationGetOptions applicationGetOptions)

Parameters:

applicationId - The ID of the application.

applicationGetOptions - Additional parameters for the operation

Returns:

the ApplicationSummary object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAsync

public Observable getAsync(String applicationId)

Parameters:

applicationId - The ID of the application.

Returns:

the observable to the ApplicationSummary object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public Observable getAsync(String applicationId, ApplicationGetOptions applicationGetOptions)

Parameters:

applicationId - The ID of the application.

applicationGetOptions - Additional parameters for the operation

Returns:

the observable to the ApplicationSummary object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String applicationId, ApplicationGetOptions applicationGetOptions, final ServiceCallback serviceCallback)

Parameters:

applicationId - The ID of the application.

applicationGetOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String applicationId, final ServiceCallback serviceCallback)

Parameters:

applicationId - The ID of the application.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable> getWithServiceResponseAsync(String applicationId)

Parameters:

applicationId - The ID of the application.

Returns:

the observable to the ApplicationSummary object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable> getWithServiceResponseAsync(String applicationId, ApplicationGetOptions applicationGetOptions)

Parameters:

applicationId - The ID of the application.

applicationGetOptions - Additional parameters for the operation

Returns:

the observable to the ApplicationSummary object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

public PagedList list()

Lists all of the applications available in the specified account. This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.

Returns:

the PagedList<ApplicationSummary> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

list

public PagedList list(final ApplicationListOptions applicationListOptions)

Parameters:

applicationListOptions - Additional parameters for the operation

Returns:

the PagedList<ApplicationSummary> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listAsync

public Observable> listAsync()

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public Observable> listAsync(final ApplicationListOptions applicationListOptions)

Parameters:

applicationListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture> listAsync(final ApplicationListOptions applicationListOptions, final ListOperationCallback serviceCallback)

Parameters:

applicationListOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture> listAsync(final ListOperationCallback serviceCallback)

Parameters:

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNext

public PagedList listNext(final String nextPageLink)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the PagedList<ApplicationSummary> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listNext

public PagedList listNext(final String nextPageLink, final ApplicationListNextOptions applicationListNextOptions)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

applicationListNextOptions - Additional parameters for the operation

Returns:

the PagedList<ApplicationSummary> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listNextAsync

public Observable> listNextAsync(final String nextPageLink)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public Observable> listNextAsync(final String nextPageLink, final ApplicationListNextOptions applicationListNextOptions)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

applicationListNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public ServiceFuture> listNextAsync(final String nextPageLink, final ApplicationListNextOptions applicationListNextOptions, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

applicationListNextOptions - Additional parameters for the operation

serviceFuture - the ServiceFuture object tracking the Retrofit calls

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public ServiceFuture> listNextAsync(final String nextPageLink, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

serviceFuture - the ServiceFuture object tracking the Retrofit calls

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextWithServiceResponseAsync

public Observable, ApplicationListHeaders>> listNextWithServiceResponseAsync(final String nextPageLink)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextWithServiceResponseAsync

public Observable, ApplicationListHeaders>> listNextWithServiceResponseAsync(final String nextPageLink, final ApplicationListNextOptions applicationListNextOptions)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

applicationListNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable, ApplicationListHeaders>> listWithServiceResponseAsync()

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable, ApplicationListHeaders>> listWithServiceResponseAsync(final ApplicationListOptions applicationListOptions)

Parameters:

applicationListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

Share via

Applications Interface

Method Summary

Method Details

get

get

getAsync

getAsync

getAsync

getAsync

getWithServiceResponseAsync

getWithServiceResponseAsync

list

list

listAsync

listAsync

listAsync

listAsync

listNext

listNext

listNextAsync

listNextAsync

listNextAsync

listNextAsync

listNextWithServiceResponseAsync

listNextWithServiceResponseAsync

listWithServiceResponseAsync

listWithServiceResponseAsync

Applies to

Additional resources