Pipelines Interface

public interface Pipelines

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

Method Summary

Modifier and Type Method and Description
JobPipelineInformation get(String accountName, UUID pipelineIdentity)

Gets the Pipeline information for the specified pipeline ID.

JobPipelineInformation get(String accountName, UUID pipelineIdentity, DateTime startDateTime, DateTime endDateTime)

Gets the Pipeline information for the specified pipeline ID.

Observable<JobPipelineInformation> getAsync(String accountName, UUID pipelineIdentity)

Gets the Pipeline information for the specified pipeline ID.

Observable<JobPipelineInformation> getAsync(String accountName, UUID pipelineIdentity, DateTime startDateTime, DateTime endDateTime)

Gets the Pipeline information for the specified pipeline ID.

ServiceFuture<JobPipelineInformation> getAsync(String accountName, UUID pipelineIdentity, DateTime startDateTime, DateTime endDateTime, final ServiceCallback<JobPipelineInformation> serviceCallback)

Gets the Pipeline information for the specified pipeline ID.

ServiceFuture<JobPipelineInformation> getAsync(String accountName, UUID pipelineIdentity, final ServiceCallback<JobPipelineInformation> serviceCallback)

Gets the Pipeline information for the specified pipeline ID.

Observable<ServiceResponse<JobPipelineInformation>> getWithServiceResponseAsync(String accountName, UUID pipelineIdentity)

Gets the Pipeline information for the specified pipeline ID.

Observable<ServiceResponse<JobPipelineInformation>> getWithServiceResponseAsync(String accountName, UUID pipelineIdentity, DateTime startDateTime, DateTime endDateTime)

Gets the Pipeline information for the specified pipeline ID.

PagedList<JobPipelineInformation> list(final String accountName)

Lists all pipelines.

PagedList<JobPipelineInformation> list(final String accountName, final DateTime startDateTime, final DateTime endDateTime)

Lists all pipelines.

Observable<Page<JobPipelineInformation>> listAsync(final String accountName)

Lists all pipelines.

Observable<Page<JobPipelineInformation>> listAsync(final String accountName, final DateTime startDateTime, final DateTime endDateTime)

Lists all pipelines.

ServiceFuture<List<JobPipelineInformation>> listAsync(final String accountName, final DateTime startDateTime, final DateTime endDateTime, final ListOperationCallback<JobPipelineInformation> serviceCallback)

Lists all pipelines.

ServiceFuture<List<JobPipelineInformation>> listAsync(final String accountName, final ListOperationCallback<JobPipelineInformation> serviceCallback)

Lists all pipelines.

PagedList<JobPipelineInformation> listNext(final String nextPageLink)

Lists all pipelines.

Observable<Page<JobPipelineInformation>> listNextAsync(final String nextPageLink)

Lists all pipelines.

ServiceFuture<List<JobPipelineInformation>> listNextAsync(final String nextPageLink, final ServiceFuture<List<JobPipelineInformation>> serviceFuture, final ListOperationCallback<JobPipelineInformation> serviceCallback)

Lists all pipelines.

Observable<ServiceResponse<Page<JobPipelineInformation>>> listNextWithServiceResponseAsync(final String nextPageLink)

Lists all pipelines.

Observable<ServiceResponse<Page<JobPipelineInformation>>> listWithServiceResponseAsync(final String accountName)

Lists all pipelines.

Observable<ServiceResponse<Page<JobPipelineInformation>>> listWithServiceResponseAsync(final String accountName, final DateTime startDateTime, final DateTime endDateTime)

Lists all pipelines.

Method Details

get

public JobPipelineInformation get(String accountName, UUID pipelineIdentity)

Gets the Pipeline information for the specified pipeline ID.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
pipelineIdentity - Pipeline ID.

Returns:

the JobPipelineInformation object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

get

public JobPipelineInformation get(String accountName, UUID pipelineIdentity, DateTime startDateTime, DateTime endDateTime)

Gets the Pipeline information for the specified pipeline ID.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
pipelineIdentity - Pipeline ID.
startDateTime - The start date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
endDateTime - The end date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.

Returns:

the JobPipelineInformation object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - 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 accountName, UUID pipelineIdentity)

Gets the Pipeline information for the specified pipeline ID.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
pipelineIdentity - Pipeline ID.

Returns:

the observable to the JobPipelineInformation object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public Observable getAsync(String accountName, UUID pipelineIdentity, DateTime startDateTime, DateTime endDateTime)

Gets the Pipeline information for the specified pipeline ID.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
pipelineIdentity - Pipeline ID.
startDateTime - The start date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
endDateTime - The end date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.

Returns:

the observable to the JobPipelineInformation object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String accountName, UUID pipelineIdentity, DateTime startDateTime, DateTime endDateTime, final ServiceCallback serviceCallback)

Gets the Pipeline information for the specified pipeline ID.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
pipelineIdentity - Pipeline ID.
startDateTime - The start date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
endDateTime - The end date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
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 accountName, UUID pipelineIdentity, final ServiceCallback serviceCallback)

Gets the Pipeline information for the specified pipeline ID.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
pipelineIdentity - Pipeline ID.
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 accountName, UUID pipelineIdentity)

Gets the Pipeline information for the specified pipeline ID.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
pipelineIdentity - Pipeline ID.

Returns:

the observable to the JobPipelineInformation object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable<>> getWithServiceResponseAsync(String accountName, UUID pipelineIdentity, DateTime startDateTime, DateTime endDateTime)

Gets the Pipeline information for the specified pipeline ID.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
pipelineIdentity - Pipeline ID.
startDateTime - The start date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.
endDateTime - The end date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.

Returns:

the observable to the JobPipelineInformation object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

public PagedList list(final String accountName)

Lists all pipelines.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.

Returns:

the PagedList<JobPipelineInformation> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - 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 String accountName, final DateTime startDateTime, final DateTime endDateTime)

Lists all pipelines.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
startDateTime - The start date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.
endDateTime - The end date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.

Returns:

the PagedList<JobPipelineInformation> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - 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(final String accountName)

Lists all pipelines.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.

Returns:

the observable to the PagedList<JobPipelineInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public Observable<>> listAsync(final String accountName, final DateTime startDateTime, final DateTime endDateTime)

Lists all pipelines.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
startDateTime - The start date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.
endDateTime - The end date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.

Returns:

the observable to the PagedList<JobPipelineInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture<>> listAsync(final String accountName, final DateTime startDateTime, final DateTime endDateTime, final ListOperationCallback serviceCallback)

Lists all pipelines.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
startDateTime - The start date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.
endDateTime - The end date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.
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 String accountName, final ListOperationCallback serviceCallback)

Lists all pipelines.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
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)

Lists all pipelines.

Parameters:

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

Returns:

the PagedList<JobPipelineInformation> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
CloudException - 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)

Lists all pipelines.

Parameters:

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

Returns:

the observable to the PagedList<JobPipelineInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

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

Lists all pipelines.

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<><>>> listNextWithServiceResponseAsync(final String nextPageLink)

Lists all pipelines.

Parameters:

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

Returns:

the observable to the PagedList<JobPipelineInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable<><>>> listWithServiceResponseAsync(final String accountName)

Lists all pipelines.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.

Returns:

the observable to the PagedList<JobPipelineInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable<><>>> listWithServiceResponseAsync(final String accountName, final DateTime startDateTime, final DateTime endDateTime)

Lists all pipelines.

Parameters:

accountName - The Azure Data Lake Analytics account to execute job operations on.
startDateTime - The start date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.
endDateTime - The end date for when to get the list of pipelines. The startDateTime and endDateTime can be no more than 30 days apart.

Returns:

the observable to the PagedList<JobPipelineInformation> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

Applies to