Share via


CatalogsClient Interface

public interface CatalogsClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<Void>,Void> beginConnect(String resourceGroupName, String devCenterName, String catalogName)

Connects a catalog to enable syncing.

abstract SyncPoller<PollResult<Void>,Void> beginConnect(String resourceGroupName, String devCenterName, String catalogName, Context context)

Connects a catalog to enable syncing.

abstract SyncPoller<PollResult<CatalogInner>,CatalogInner> beginCreateOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body)

Creates or updates a catalog.

abstract SyncPoller<PollResult<CatalogInner>,CatalogInner> beginCreateOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body, Context context)

Creates or updates a catalog.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String devCenterName, String catalogName)

Deletes a catalog resource.

abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String devCenterName, String catalogName, Context context)

Deletes a catalog resource.

abstract SyncPoller<PollResult<Void>,Void> beginSync(String resourceGroupName, String devCenterName, String catalogName)

Syncs templates for a template source.

abstract SyncPoller<PollResult<Void>,Void> beginSync(String resourceGroupName, String devCenterName, String catalogName, Context context)

Syncs templates for a template source.

abstract SyncPoller<PollResult<CatalogInner>,CatalogInner> beginUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body)

Partially updates a catalog.

abstract SyncPoller<PollResult<CatalogInner>,CatalogInner> beginUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body, Context context)

Partially updates a catalog.

abstract void connect(String resourceGroupName, String devCenterName, String catalogName)

Connects a catalog to enable syncing.

abstract void connect(String resourceGroupName, String devCenterName, String catalogName, Context context)

Connects a catalog to enable syncing.

abstract CatalogInner createOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body)

Creates or updates a catalog.

abstract CatalogInner createOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body, Context context)

Creates or updates a catalog.

abstract void delete(String resourceGroupName, String devCenterName, String catalogName)

Deletes a catalog resource.

abstract void delete(String resourceGroupName, String devCenterName, String catalogName, Context context)

Deletes a catalog resource.

abstract CatalogInner get(String resourceGroupName, String devCenterName, String catalogName)

Gets a catalog.

abstract SyncErrorDetailsInner getSyncErrorDetails(String resourceGroupName, String devCenterName, String catalogName)

Gets catalog synchronization error details.

abstract Response<SyncErrorDetailsInner> getSyncErrorDetailsWithResponse(String resourceGroupName, String devCenterName, String catalogName, Context context)

Gets catalog synchronization error details.

abstract Response<CatalogInner> getWithResponse(String resourceGroupName, String devCenterName, String catalogName, Context context)

Gets a catalog.

abstract PagedIterable<CatalogInner> listByDevCenter(String resourceGroupName, String devCenterName)

Lists catalogs for a devcenter.

abstract PagedIterable<CatalogInner> listByDevCenter(String resourceGroupName, String devCenterName, Integer top, Context context)

Lists catalogs for a devcenter.

abstract void sync(String resourceGroupName, String devCenterName, String catalogName)

Syncs templates for a template source.

abstract void sync(String resourceGroupName, String devCenterName, String catalogName, Context context)

Syncs templates for a template source.

abstract CatalogInner update(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body)

Partially updates a catalog.

abstract CatalogInner update(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body, Context context)

Partially updates a catalog.

Method Details

beginConnect

public abstract SyncPoller<PollResult<Void>,Void> beginConnect(String resourceGroupName, String devCenterName, String catalogName)

Connects a catalog to enable syncing.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginConnect

public abstract SyncPoller<PollResult<Void>,Void> beginConnect(String resourceGroupName, String devCenterName, String catalogName, Context context)

Connects a catalog to enable syncing.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<CatalogInner>,CatalogInner> beginCreateOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body)

Creates or updates a catalog.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
body - Represents a catalog.

Returns:

the SyncPoller<T,U> for polling of represents a catalog.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<CatalogInner>,CatalogInner> beginCreateOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body, Context context)

Creates or updates a catalog.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
body - Represents a catalog.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of represents a catalog.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String devCenterName, String catalogName)

Deletes a catalog resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String devCenterName, String catalogName, Context context)

Deletes a catalog resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginSync

public abstract SyncPoller<PollResult<Void>,Void> beginSync(String resourceGroupName, String devCenterName, String catalogName)

Syncs templates for a template source.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginSync

public abstract SyncPoller<PollResult<Void>,Void> beginSync(String resourceGroupName, String devCenterName, String catalogName, Context context)

Syncs templates for a template source.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller<PollResult<CatalogInner>,CatalogInner> beginUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body)

Partially updates a catalog.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
body - Updatable catalog properties.

Returns:

the SyncPoller<T,U> for polling of represents a catalog.

beginUpdate

public abstract SyncPoller<PollResult<CatalogInner>,CatalogInner> beginUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body, Context context)

Partially updates a catalog.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
body - Updatable catalog properties.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of represents a catalog.

connect

public abstract void connect(String resourceGroupName, String devCenterName, String catalogName)

Connects a catalog to enable syncing.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.

connect

public abstract void connect(String resourceGroupName, String devCenterName, String catalogName, Context context)

Connects a catalog to enable syncing.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
context - The context to associate with this operation.

createOrUpdate

public abstract CatalogInner createOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body)

Creates or updates a catalog.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
body - Represents a catalog.

Returns:

represents a catalog.

createOrUpdate

public abstract CatalogInner createOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body, Context context)

Creates or updates a catalog.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
body - Represents a catalog.
context - The context to associate with this operation.

Returns:

represents a catalog.

delete

public abstract void delete(String resourceGroupName, String devCenterName, String catalogName)

Deletes a catalog resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.

delete

public abstract void delete(String resourceGroupName, String devCenterName, String catalogName, Context context)

Deletes a catalog resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
context - The context to associate with this operation.

get

public abstract CatalogInner get(String resourceGroupName, String devCenterName, String catalogName)

Gets a catalog.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.

Returns:

a catalog.

getSyncErrorDetails

public abstract SyncErrorDetailsInner getSyncErrorDetails(String resourceGroupName, String devCenterName, String catalogName)

Gets catalog synchronization error details.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.

Returns:

catalog synchronization error details.

getSyncErrorDetailsWithResponse

public abstract Response<SyncErrorDetailsInner> getSyncErrorDetailsWithResponse(String resourceGroupName, String devCenterName, String catalogName, Context context)

Gets catalog synchronization error details.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
context - The context to associate with this operation.

Returns:

catalog synchronization error details along with Response<T>.

getWithResponse

public abstract Response<CatalogInner> getWithResponse(String resourceGroupName, String devCenterName, String catalogName, Context context)

Gets a catalog.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
context - The context to associate with this operation.

Returns:

a catalog along with Response<T>.

listByDevCenter

public abstract PagedIterable<CatalogInner> listByDevCenter(String resourceGroupName, String devCenterName)

Lists catalogs for a devcenter.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.

Returns:

results of the catalog list operation as paginated response with PagedIterable<T>.

listByDevCenter

public abstract PagedIterable<CatalogInner> listByDevCenter(String resourceGroupName, String devCenterName, Integer top, Context context)

Lists catalogs for a devcenter.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
top - The maximum number of resources to return from the operation. Example: '$top=10'.
context - The context to associate with this operation.

Returns:

results of the catalog list operation as paginated response with PagedIterable<T>.

sync

public abstract void sync(String resourceGroupName, String devCenterName, String catalogName)

Syncs templates for a template source.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.

sync

public abstract void sync(String resourceGroupName, String devCenterName, String catalogName, Context context)

Syncs templates for a template source.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
context - The context to associate with this operation.

update

public abstract CatalogInner update(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body)

Partially updates a catalog.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
body - Updatable catalog properties.

Returns:

represents a catalog.

update

public abstract CatalogInner update(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body, Context context)

Partially updates a catalog.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
devCenterName - The name of the devcenter.
catalogName - The name of the Catalog.
body - Updatable catalog properties.
context - The context to associate with this operation.

Returns:

represents a catalog.

Applies to