com.microsoft.azure.batch.protocol

Interface Applications

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.
ApplicationSummary	get(String applicationId, ApplicationGetOptions applicationGetOptions) Gets information about the specified application.
rx.Observable<ApplicationSummary>	getAsync(String applicationId) Gets information about the specified application.
rx.Observable<ApplicationSummary>	getAsync(String applicationId, ApplicationGetOptions applicationGetOptions) Gets information about the specified application.
ServiceFuture<ApplicationSummary>	getAsync(String applicationId, ApplicationGetOptions applicationGetOptions, ServiceCallback<ApplicationSummary> serviceCallback) Gets information about the specified application.
ServiceFuture<ApplicationSummary>	getAsync(String applicationId, ServiceCallback<ApplicationSummary> serviceCallback) Gets information about the specified application.
rx.Observable<ServiceResponseWithHeaders<ApplicationSummary,ApplicationGetHeaders>>	getWithServiceResponseAsync(String applicationId) Gets information about the specified application.
rx.Observable<ServiceResponseWithHeaders<ApplicationSummary,ApplicationGetHeaders>>	getWithServiceResponseAsync(String applicationId, ApplicationGetOptions applicationGetOptions) Gets information about the specified application.
PagedList<ApplicationSummary>	list() Lists all of the applications available in the specified account.
PagedList<ApplicationSummary>	list(ApplicationListOptions applicationListOptions) Lists all of the applications available in the specified account.
rx.Observable<Page<ApplicationSummary>>	listAsync() Lists all of the applications available in the specified account.
rx.Observable<Page<ApplicationSummary>>	listAsync(ApplicationListOptions applicationListOptions) Lists all of the applications available in the specified account.
ServiceFuture<List<ApplicationSummary>>	listAsync(ApplicationListOptions applicationListOptions, ListOperationCallback<ApplicationSummary> serviceCallback) Lists all of the applications available in the specified account.
ServiceFuture<List<ApplicationSummary>>	listAsync(ListOperationCallback<ApplicationSummary> serviceCallback) Lists all of the applications available in the specified account.
PagedList<ApplicationSummary>	listNext(String nextPageLink) Lists all of the applications available in the specified account.
PagedList<ApplicationSummary>	listNext(String nextPageLink, ApplicationListNextOptions applicationListNextOptions) Lists all of the applications available in the specified account.
rx.Observable<Page<ApplicationSummary>>	listNextAsync(String nextPageLink) Lists all of the applications available in the specified account.
rx.Observable<Page<ApplicationSummary>>	listNextAsync(String nextPageLink, ApplicationListNextOptions applicationListNextOptions) Lists all of the applications available in the specified account.
ServiceFuture<List<ApplicationSummary>>	listNextAsync(String nextPageLink, ApplicationListNextOptions applicationListNextOptions, ServiceFuture<List<ApplicationSummary>> serviceFuture, ListOperationCallback<ApplicationSummary> serviceCallback) Lists all of the applications available in the specified account.
ServiceFuture<List<ApplicationSummary>>	listNextAsync(String nextPageLink, ServiceFuture<List<ApplicationSummary>> serviceFuture, ListOperationCallback<ApplicationSummary> serviceCallback) Lists all of the applications available in the specified account.
rx.Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>,ApplicationListHeaders>>	listNextWithServiceResponseAsync(String nextPageLink) Lists all of the applications available in the specified account.
rx.Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>,ApplicationListHeaders>>	listNextWithServiceResponseAsync(String nextPageLink, ApplicationListNextOptions applicationListNextOptions) Lists all of the applications available in the specified account.
rx.Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>,ApplicationListHeaders>>	listWithServiceResponseAsync() Lists all of the applications available in the specified account.
rx.Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>,ApplicationListHeaders>>	listWithServiceResponseAsync(ApplicationListOptions applicationListOptions) Lists all of the applications available in the specified account.

Method Detail

list

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.

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

ServiceFuture<List<ApplicationSummary>> listAsync(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.

Parameters:

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

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

rx.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.

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

rx.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.

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

PagedList<ApplicationSummary> list(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.

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

ServiceFuture<List<ApplicationSummary>> listAsync(ApplicationListOptions applicationListOptions,
                                                  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.

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

rx.Observable<Page<ApplicationSummary>> listAsync(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.

Parameters:

applicationListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

rx.Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>,ApplicationListHeaders>> listWithServiceResponseAsync(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.

Parameters:

applicationListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<ApplicationSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

get

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

getAsync

ServiceFuture<ApplicationSummary> getAsync(String applicationId,
                                           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.

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

getAsync

rx.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.

Parameters:

applicationId - The ID of the application.

Returns:

the observable to the ApplicationSummary object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

rx.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.

Parameters:

applicationId - The ID of the application.

Returns:

the observable to the ApplicationSummary object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

get

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.

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

ServiceFuture<ApplicationSummary> getAsync(String applicationId,
                                           ApplicationGetOptions applicationGetOptions,
                                           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.

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

rx.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.

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

getWithServiceResponseAsync

rx.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.

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

listNext

PagedList<ApplicationSummary> listNext(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.

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

listNextAsync

ServiceFuture<List<ApplicationSummary>> listNextAsync(String nextPageLink,
                                                      ServiceFuture<List<ApplicationSummary>> serviceFuture,
                                                      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.

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

listNextAsync

rx.Observable<Page<ApplicationSummary>> listNextAsync(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.

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

rx.Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>,ApplicationListHeaders>> listNextWithServiceResponseAsync(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.

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

listNext

PagedList<ApplicationSummary> listNext(String nextPageLink,
                                       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.

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

ServiceFuture<List<ApplicationSummary>> listNextAsync(String nextPageLink,
                                                      ApplicationListNextOptions applicationListNextOptions,
                                                      ServiceFuture<List<ApplicationSummary>> serviceFuture,
                                                      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.

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

rx.Observable<Page<ApplicationSummary>> listNextAsync(String nextPageLink,
                                                      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.

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

listNextWithServiceResponseAsync

rx.Observable<ServiceResponseWithHeaders<Page<ApplicationSummary>,ApplicationListHeaders>> listNextWithServiceResponseAsync(String nextPageLink,
                                                                                                                            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.

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