Package com.azure.resourcemanager.containerregistry.fluent

Interface RunsClient

public interface RunsClient

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

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginCancel(String resourceGroupName, String registryName, String runId)	Cancel an existing run.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginCancel(String resourceGroupName, String registryName, String runId, com.azure.core.util.Context context)	Cancel an existing run.
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,Void>	beginCancelAsync(String resourceGroupName, String registryName, String runId)	Cancel an existing run.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RunInner>,RunInner>	beginUpdate(String resourceGroupName, String registryName, String runId, RunUpdateParameters runUpdateParameters)	Patch the run properties.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RunInner>,RunInner>	beginUpdate(String resourceGroupName, String registryName, String runId, RunUpdateParameters runUpdateParameters, com.azure.core.util.Context context)	Patch the run properties.
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<RunInner>,RunInner>	beginUpdateAsync(String resourceGroupName, String registryName, String runId, RunUpdateParameters runUpdateParameters)	Patch the run properties.
void	cancel(String resourceGroupName, String registryName, String runId)	Cancel an existing run.
void	cancel(String resourceGroupName, String registryName, String runId, com.azure.core.util.Context context)	Cancel an existing run.
Mono<Void>	cancelAsync(String resourceGroupName, String registryName, String runId)	Cancel an existing run.
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>	cancelWithResponseAsync(String resourceGroupName, String registryName, String runId)	Cancel an existing run.
RunInner	get(String resourceGroupName, String registryName, String runId)	Gets the detailed information for a given run.
Mono<RunInner>	getAsync(String resourceGroupName, String registryName, String runId)	Gets the detailed information for a given run.
RunGetLogResultInner	getLogSasUrl(String resourceGroupName, String registryName, String runId)	Gets a link to download the run logs.
Mono<RunGetLogResultInner>	getLogSasUrlAsync(String resourceGroupName, String registryName, String runId)	Gets a link to download the run logs.
com.azure.core.http.rest.Response<RunGetLogResultInner>	getLogSasUrlWithResponse(String resourceGroupName, String registryName, String runId, com.azure.core.util.Context context)	Gets a link to download the run logs.
Mono<com.azure.core.http.rest.Response<RunGetLogResultInner>>	getLogSasUrlWithResponseAsync(String resourceGroupName, String registryName, String runId)	Gets a link to download the run logs.
com.azure.core.http.rest.Response<RunInner>	getWithResponse(String resourceGroupName, String registryName, String runId, com.azure.core.util.Context context)	Gets the detailed information for a given run.
Mono<com.azure.core.http.rest.Response<RunInner>>	getWithResponseAsync(String resourceGroupName, String registryName, String runId)	Gets the detailed information for a given run.
com.azure.core.http.rest.PagedIterable<RunInner>	list(String resourceGroupName, String registryName)	Gets all the runs for a registry.
com.azure.core.http.rest.PagedIterable<RunInner>	list(String resourceGroupName, String registryName, String filter, Integer top, com.azure.core.util.Context context)	Gets all the runs for a registry.
com.azure.core.http.rest.PagedFlux<RunInner>	listAsync(String resourceGroupName, String registryName)	Gets all the runs for a registry.
com.azure.core.http.rest.PagedFlux<RunInner>	listAsync(String resourceGroupName, String registryName, String filter, Integer top)	Gets all the runs for a registry.
RunInner	update(String resourceGroupName, String registryName, String runId, RunUpdateParameters runUpdateParameters)	Patch the run properties.
RunInner	update(String resourceGroupName, String registryName, String runId, RunUpdateParameters runUpdateParameters, com.azure.core.util.Context context)	Patch the run properties.
Mono<RunInner>	updateAsync(String resourceGroupName, String registryName, String runId, RunUpdateParameters runUpdateParameters)	Patch the run properties.
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>	updateWithResponseAsync(String resourceGroupName, String registryName, String runId, RunUpdateParameters runUpdateParameters)	Patch the run properties.

Method Detail

listAsync

com.azure.core.http.rest.PagedFlux<RunInner> listAsync(String resourceGroupName,
                                                       String registryName,
                                                       String filter,
                                                       Integer top)

Gets all the runs for a registry.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

filter - The runs filter to apply on the operation. Arithmetic operators are not supported. The allowed string function is 'contains'. All logical operators except 'Not', 'Has', 'All' are allowed.

top - $top is supported for get list of runs, which limits the maximum number of runs to return.

Returns:

all the runs for a registry.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

listAsync

com.azure.core.http.rest.PagedFlux<RunInner> listAsync(String resourceGroupName,
                                                       String registryName)

Gets all the runs for a registry.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

Returns:

all the runs for a registry.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

list

com.azure.core.http.rest.PagedIterable<RunInner> list(String resourceGroupName,
                                                      String registryName)

Gets all the runs for a registry.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

Returns:

all the runs for a registry.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

list

com.azure.core.http.rest.PagedIterable<RunInner> list(String resourceGroupName,
                                                      String registryName,
                                                      String filter,
                                                      Integer top,
                                                      com.azure.core.util.Context context)

Gets all the runs for a registry.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

filter - The runs filter to apply on the operation. Arithmetic operators are not supported. The allowed string function is 'contains'. All logical operators except 'Not', 'Has', 'All' are allowed.

top - $top is supported for get list of runs, which limits the maximum number of runs to return.

context - The context to associate with this operation.

Returns:

all the runs for a registry.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getWithResponseAsync

Mono<com.azure.core.http.rest.Response<RunInner>> getWithResponseAsync(String resourceGroupName,
                                                                       String registryName,
                                                                       String runId)

Gets the detailed information for a given run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Returns:

the detailed information for a given run.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getAsync

Mono<RunInner> getAsync(String resourceGroupName,
                        String registryName,
                        String runId)

Gets the detailed information for a given run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Returns:

the detailed information for a given run.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

get

RunInner get(String resourceGroupName,
             String registryName,
             String runId)

Gets the detailed information for a given run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Returns:

the detailed information for a given run.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getWithResponse

com.azure.core.http.rest.Response<RunInner> getWithResponse(String resourceGroupName,
                                                            String registryName,
                                                            String runId,
                                                            com.azure.core.util.Context context)

Gets the detailed information for a given run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

context - The context to associate with this operation.

Returns:

the detailed information for a given run.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

updateWithResponseAsync

Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> updateWithResponseAsync(String resourceGroupName,
                                                                                  String registryName,
                                                                                  String runId,
                                                                                  RunUpdateParameters runUpdateParameters)

Patch the run properties.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

runUpdateParameters - The run update properties.

Returns:

run resource properties.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginUpdateAsync

com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<RunInner>,RunInner> beginUpdateAsync(String resourceGroupName,
                                                                                                                               String registryName,
                                                                                                                               String runId,
                                                                                                                               RunUpdateParameters runUpdateParameters)

Patch the run properties.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

runUpdateParameters - The run update properties.

Returns:

run resource properties.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RunInner>,RunInner> beginUpdate(String resourceGroupName,
                                                                                                                          String registryName,
                                                                                                                          String runId,
                                                                                                                          RunUpdateParameters runUpdateParameters)

Patch the run properties.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

runUpdateParameters - The run update properties.

Returns:

run resource properties.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<RunInner>,RunInner> beginUpdate(String resourceGroupName,
                                                                                                                          String registryName,
                                                                                                                          String runId,
                                                                                                                          RunUpdateParameters runUpdateParameters,
                                                                                                                          com.azure.core.util.Context context)

Patch the run properties.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

runUpdateParameters - The run update properties.

context - The context to associate with this operation.

Returns:

run resource properties.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

updateAsync

Mono<RunInner> updateAsync(String resourceGroupName,
                           String registryName,
                           String runId,
                           RunUpdateParameters runUpdateParameters)

Patch the run properties.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

runUpdateParameters - The run update properties.

Returns:

run resource properties.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

update

RunInner update(String resourceGroupName,
                String registryName,
                String runId,
                RunUpdateParameters runUpdateParameters)

Patch the run properties.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

runUpdateParameters - The run update properties.

Returns:

run resource properties.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

update

RunInner update(String resourceGroupName,
                String registryName,
                String runId,
                RunUpdateParameters runUpdateParameters,
                com.azure.core.util.Context context)

Patch the run properties.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

runUpdateParameters - The run update properties.

context - The context to associate with this operation.

Returns:

run resource properties.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getLogSasUrlWithResponseAsync

Mono<com.azure.core.http.rest.Response<RunGetLogResultInner>> getLogSasUrlWithResponseAsync(String resourceGroupName,
                                                                                            String registryName,
                                                                                            String runId)

Gets a link to download the run logs.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Returns:

a link to download the run logs.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getLogSasUrlAsync

Mono<RunGetLogResultInner> getLogSasUrlAsync(String resourceGroupName,
                                             String registryName,
                                             String runId)

Gets a link to download the run logs.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Returns:

a link to download the run logs.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getLogSasUrl

RunGetLogResultInner getLogSasUrl(String resourceGroupName,
                                  String registryName,
                                  String runId)

Gets a link to download the run logs.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Returns:

a link to download the run logs.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getLogSasUrlWithResponse

com.azure.core.http.rest.Response<RunGetLogResultInner> getLogSasUrlWithResponse(String resourceGroupName,
                                                                                 String registryName,
                                                                                 String runId,
                                                                                 com.azure.core.util.Context context)

Gets a link to download the run logs.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

context - The context to associate with this operation.

Returns:

a link to download the run logs.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

cancelWithResponseAsync

Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> cancelWithResponseAsync(String resourceGroupName,
                                                                                  String registryName,
                                                                                  String runId)

Cancel an existing run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginCancelAsync

com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,Void> beginCancelAsync(String resourceGroupName,
                                                                                                                       String registryName,
                                                                                                                       String runId)

Cancel an existing run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginCancel

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginCancel(String resourceGroupName,
                                                                                                                  String registryName,
                                                                                                                  String runId)

Cancel an existing run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginCancel

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginCancel(String resourceGroupName,
                                                                                                                  String registryName,
                                                                                                                  String runId,
                                                                                                                  com.azure.core.util.Context context)

Cancel an existing run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

context - The context to associate with this operation.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

cancelAsync

Mono<Void> cancelAsync(String resourceGroupName,
                       String registryName,
                       String runId)

Cancel an existing run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

cancel

void cancel(String resourceGroupName,
            String registryName,
            String runId)

Cancel an existing run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

cancel

void cancel(String resourceGroupName,
            String registryName,
            String runId,
            com.azure.core.util.Context context)

Cancel an existing run.

Parameters:

resourceGroupName - The name of the resource group to which the container registry belongs.

registryName - The name of the container registry.

runId - The run ID.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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