Interface ICcdManagementServiceSdk

Service for CCD Management Provides the ability to manage buckets, badges, content, entries, and releases.

Namespace: Unity.Services.Ccd.Management

Assembly: Unity.Services.Ccd.Management.dll

Syntax

public interface ICcdManagementServiceSdk

Methods

AssignBadgeAsync(AssignBadgeOptions)

Async Operation. Assign a badge. Either "ReleaseId" or "ReleaseNum" should be specified in assignBadgeOptions, but not both.

Declaration

Task<CcdBadge> AssignBadgeAsync(AssignBadgeOptions assignBadgeOptions)

Parameters

Type	Name	Description
AssignBadgeOptions	assignBadgeOptions	Parameters for assigning a badge.

Returns

Type	Description
Task<CcdBadge>	CcdBadge that was assigned.

Exceptions

Type	Condition
CcdManagementException

CreateBucketAsync(CreateBucketOptions)

Async Operation. Create bucket. Required: Name, Description.

Declaration

Task<CcdBucket> CreateBucketAsync(CreateBucketOptions createBucketOptions)

Parameters

Type	Name	Description
CreateBucketOptions	createBucketOptions	Parameters for creating a bucket.

Returns

Type	Description
Task<CcdBucket>	CcdBucket that was created.

Exceptions

Type	Condition
CcdManagementException

CreateContentAsync(Guid, Guid)

Async Operation. Create content upload for TUS.

Declaration

Task<string> CreateContentAsync(Guid bucketId, Guid entryId)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
Guid	entryId	Id of the entry.

Returns

Type	Description
Task<string>	Location to upload to via TUS.

Exceptions

Type	Condition
CcdManagementException

CreateEntryAsync(Guid, EntryModelOptions)

Async Operation. Create entry. Required: BucketId, Path, ContentHash, ContentSize, ContentType.

Declaration

Task<CcdEntry> CreateEntryAsync(Guid bucketId, EntryModelOptions entry)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
EntryModelOptions	entry	Parameters for the entry.

Returns

Type	Description
Task<CcdEntry>	CcdEntry that was created.

Exceptions

Type	Condition
CcdManagementException

CreateOrUpdateEntryByPathAsync(EntryByPathOptions, EntryModelOptions)

Async Operation. Create or update entry by path. Required: BucketId, Path, ContentHash, ContentSize, ContentType.

Declaration

Task<CcdEntry> CreateOrUpdateEntryByPathAsync(EntryByPathOptions entryByPathOptions, EntryModelOptions entry)

Parameters

Type	Name	Description
EntryByPathOptions	entryByPathOptions	Parameters for entry path.
EntryModelOptions	entry	Parameters for the entry.

Returns

Type	Description
Task<CcdEntry>	CcdEntry that was created or updated.

Exceptions

Type	Condition
CcdManagementException

CreatePermissionAsync(CreatePermissionsOption)

Async Operation. Create a permission. Required: BucketId, Action, Permission.

Declaration

Task<CcdPermission> CreatePermissionAsync(CreatePermissionsOption permissionsOptions)

Parameters

Type	Name	Description
CreatePermissionsOption	permissionsOptions	Parameters for creating a permission.

Returns

Type	Description
Task<CcdPermission>	CcdPermission that was created.

Exceptions

Type	Condition
CcdManagementException

CreateReleaseAsync(CreateReleaseOptions)

Async Operation. Create release. Required: BucketId.

Declaration

Task<CcdRelease> CreateReleaseAsync(CreateReleaseOptions createReleaseOptions)

Parameters

Type	Name	Description
CreateReleaseOptions	createReleaseOptions	Parameters for creating a release.

Returns

Type	Description
Task<CcdRelease>	CcdRelease that was created.

Exceptions

Type	Condition
CcdManagementException

DeleteBadgeAsync(Guid, string)

Async Operation. Delete a badge.

Declaration

Task DeleteBadgeAsync(Guid bucketId, string badgeName)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
string	badgeName	Name of the badge.

Returns

Type	Description
Task	Awaitable task.

Exceptions

Type	Condition
CcdManagementException

DeleteBucketAsync(Guid)

Async Operation. Delete a bucket.

Declaration

Task DeleteBucketAsync(Guid bucketId)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.

Returns

Type	Description
Task	Awaitable task.

Exceptions

Type	Condition
CcdManagementException

DeleteEntryAsync(Guid, Guid)

Async Operation. Delete entry.

Declaration

Task DeleteEntryAsync(Guid bucketId, Guid entryId)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
Guid	entryId	Id of the entry.

Returns

Type	Description
Task	Awaitable task.

Exceptions

Type	Condition
CcdManagementException

DeletePermissionAsync(UpdatePermissionsOption, RoleOptions)

Async Operation. delete a permission. Required: BucketId, Action, Permission.

Declaration

Task DeletePermissionAsync(UpdatePermissionsOption permissionsOptions, CcdPermissionUpdate.RoleOptions role = RoleOptions.User)

Parameters

Type	Name	Description
UpdatePermissionsOption	permissionsOptions	Parameters for deleting a permission.
CcdPermissionUpdate.RoleOptions	role	Delete permission for the given role.

Returns

Type	Description
Task	Awaitable task.

Exceptions

Type	Condition
CcdManagementException

GetBadgeAsync(Guid, string)

Async Operation. Get badge.

Declaration

Task<CcdBadge> GetBadgeAsync(Guid bucketId, string badgeName)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
string	badgeName	Name of the badge.

Returns

Type	Description
Task<CcdBadge>	CcdBadge with specified badge name.

Exceptions

Type	Condition
CcdManagementException

GetBucketAsync(Guid)

Async Operation. Get a bucket.

Declaration

Task<CcdBucket> GetBucketAsync(Guid bucketId)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.

Returns

Type	Description
Task<CcdBucket>	CcdBucket with specified Id.

Exceptions

Type	Condition
CcdManagementException

GetContentAsync(EntryOptions)

Async Operation. Get content by entryid. Required: BucketId, EntryId.

Declaration

Task<Stream> GetContentAsync(EntryOptions entryOptions)

Parameters

Type	Name	Description
EntryOptions	entryOptions	Parameters to get content.

Returns

Type	Description
Task<Stream>	Stream to download content.

Exceptions

Type	Condition
CcdManagementException

GetContentStatusAsync(EntryOptions)

Async Operation. Get content status by entryid. Required: BucketId, EntryId.

Declaration

Task<ContentStatus> GetContentStatusAsync(EntryOptions entryOptions)

Parameters

Type	Name	Description
EntryOptions	entryOptions	Parameters to get content status.

Returns

Type	Description
Task<ContentStatus>	ContentStatus of the entry.

Exceptions

Type	Condition
CcdManagementException

GetContentStatusVersionAsync(EntryVersionsOptions)

Async Operation. Get content status for version of entry. Required: BucketId, EntryId, VersionId.

Declaration

Task<ContentStatus> GetContentStatusVersionAsync(EntryVersionsOptions entryVersionsOption)

Parameters

Type	Name	Description
EntryVersionsOptions	entryVersionsOption	Parameters for getting the content status by entry version.

Returns

Type	Description
Task<ContentStatus>	ContentStatus of the entry.

Exceptions

Type	Condition
CcdManagementException

GetContentVersionAsync(EntryVersionsOptions)

Async Operation. Get content for version of entry. Required: BucketId, EntryId, VersionId.

Declaration

Task<Stream> GetContentVersionAsync(EntryVersionsOptions entryVersionsOption)

Parameters

Type	Name	Description
EntryVersionsOptions	entryVersionsOption	Parameters for getting the content by entry version.

Returns

Type	Description
Task<Stream>	Stream to download content.

Exceptions

Type	Condition
CcdManagementException

GetDiffAsync(Guid)

Async Operation. Get counts of changes since last release.

Declaration

Task<CcdReleaseChangeVersion> GetDiffAsync(Guid bucketId)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.

Returns

Type	Description
Task<CcdReleaseChangeVersion>	CcdReleaseChangeVersion since the last release.

Exceptions

Type	Condition
CcdManagementException

GetDiffEntriesAsync(DiffEntriesOptions, PageOptions)

Async Operation. Get changed entries since last releases. Required: BucketId.

Declaration

Task<List<CcdReleaseEntry>> GetDiffEntriesAsync(DiffEntriesOptions diffEntriesOptions, PageOptions pageOptions = null)

Parameters

Type	Name	Description
DiffEntriesOptions	diffEntriesOptions	Parameters for getting the entries of a diff.
PageOptions	pageOptions	Pagination options.

Returns

Type	Description
Task<List<CcdReleaseEntry>>	List of CcdReleaseentry.

Exceptions

Type	Condition
CcdManagementException

GetEntriesAsync(EntryOptions, string, int)

Async Operation. Get entries for bucket. Required: BucketId

Declaration

Task<List<CcdEntry>> GetEntriesAsync(EntryOptions entryOptions, string startingAfter, int perPage = 10)

Parameters

Type	Name	Description
EntryOptions	entryOptions	Parameters for entries.
string	startingAfter	Last entryid from the previous page. Leave blank for the first page.
int	perPage	Number of entries to return per page.

Returns

Type	Description
Task<List<CcdEntry>>	List of CcdEntries.

Exceptions

Type	Condition
CcdManagementException

GetEntriesAsync(EntryOptions, PageOptions)

Async Operation. Get entries for bucket. GetEntriesAsync(EntryOptions, string, int) is more performant and should be used instead. Required: BucketId

Declaration

Task<List<CcdEntry>> GetEntriesAsync(EntryOptions entryOptions, PageOptions pageOptions = null)

Parameters

Type	Name	Description
EntryOptions	entryOptions	Parameters for entries.
PageOptions	pageOptions	Pagination options.

Returns

Type	Description
Task<List<CcdEntry>>	List of CcdEntries.

Exceptions

Type	Condition
CcdManagementException

GetEntryAsync(Guid, Guid)

Async Operation. Get entry.

Declaration

Task<CcdEntry> GetEntryAsync(Guid bucketId, Guid entryId)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
Guid	entryId	Id of the entry.

Returns

Type	Description
Task<CcdEntry>	CcdEntry with the specified Id.

Exceptions

Type	Condition
CcdManagementException

GetEntryByPathAsync(EntryByPathOptions)

Async Operation. Get entry by path. Required: BucketId, Path.

Declaration

Task<CcdEntry> GetEntryByPathAsync(EntryByPathOptions entryByPathOptions)

Parameters

Type	Name	Description
EntryByPathOptions	entryByPathOptions	Parameters of the entry.

Returns

Type	Description
Task<CcdEntry>	CcdEntry with the specified path.

Exceptions

Type	Condition
CcdManagementException

GetEntryVersionAsync(EntryVersionsOptions)

Async Operation. Get entry version. Required: BucketId, EntryId, VersionId.

Declaration

Task<CcdEntry> GetEntryVersionAsync(EntryVersionsOptions entryVersionsOption)

Parameters

Type	Name	Description
EntryVersionsOptions	entryVersionsOption	Parameters for the entry.

Returns

Type	Description
Task<CcdEntry>	CcdEntry with the specified Version Id.

Exceptions

Type	Condition
CcdManagementException

GetEntryVersionsAsync(EntryOptions, PageOptions)

Async Operation. Get entry versions. Required: BucketId, EntryId.

Declaration

Task<List<CcdVersion>> GetEntryVersionsAsync(EntryOptions entryOptions, PageOptions pageOptions = null)

Parameters

Type	Name	Description
EntryOptions	entryOptions	Parameters for the entry.
PageOptions	pageOptions	Pagination options.

Returns

Type	Description
Task<List<CcdVersion>>	List of CcdVersions for the entry.

Exceptions

Type	Condition
CcdManagementException

GetEnvironmentByNameAsync(Guid, string)

Async Operation. Get an environment for a project by name

Declaration

Task<CcdEnvironment> GetEnvironmentByNameAsync(Guid projectId, string name)

Parameters

Type	Name	Description
Guid	projectId	Id of the project.
string	name

Returns

Type	Description
Task<CcdEnvironment>	The named environment for a project

Exceptions

Type	Condition
CcdManagementException

GetOrgAsync()

Async Operation. Gets organization details..

Declaration

Task<CcdOrg> GetOrgAsync()

Returns

Type	Description
Task<CcdOrg>	Organization data.

Exceptions

Type	Condition
CcdManagementException

GetOrgUsageAsync()

Async Operation. Gets organization Usage Details.

Declaration

Task<CcdOrgUsage> GetOrgUsageAsync()

Returns

Type	Description
Task<CcdOrgUsage>	Organization usage.

Exceptions

Type	Condition
CcdManagementException

GetPermissionsAsync(Guid)

Async Operation. Get permissions for bucket.

Declaration

Task<List<CcdPermission>> GetPermissionsAsync(Guid bucketId)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.

Returns

Type	Description
Task<List<CcdPermission>>	List of CcdPermissions for the bucket.

Exceptions

Type	Condition
CcdManagementException

GetReleaseAsync(Guid, Guid)

Async Operation. Get release.

Declaration

Task<CcdRelease> GetReleaseAsync(Guid bucketId, Guid releaseId)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
Guid	releaseId	Id of the release.

Returns

Type	Description
Task<CcdRelease>	CcdRelease with the specified Id.

Exceptions

Type	Condition
CcdManagementException

GetReleaseByBadgeAsync(Guid, string)

Async Operation. Get release by badge.

Declaration

Task<CcdRelease> GetReleaseByBadgeAsync(Guid bucketId, string badgeName)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
string	badgeName	Name of the badge.

Returns

Type	Description
Task<CcdRelease>	CcdRelease with the specified badge.

Exceptions

Type	Condition
CcdManagementException

GetReleaseDiffAsync(ReleaseDiffOptions)

Async Operation. Get counts of changes between releases. Required: BucketId, (FromReleaseId or FromReleaseNum).

Note: Either "FromReleaseId" or "FromReleaseNum" should be specified, but not both. Either "ToReleaseId" or "ToReleaseNum" should be specified, but not both.

Declaration

Task<CcdReleaseChangeVersion> GetReleaseDiffAsync(ReleaseDiffOptions releaseDiffOptions)

Parameters

Type	Name	Description
ReleaseDiffOptions	releaseDiffOptions	Parameters for a release diff.

Returns

Type	Description
Task<CcdReleaseChangeVersion>	CcdReleaseChangeVersion of the diff.

Exceptions

Type	Condition
CcdManagementException

GetReleaseDiffEntriesAsync(ReleaseDiffOptions, PageOptions)

Async Operation. Get changed entries between releases. Required: BucketId, (FromReleaseId or FromReleaseNum).

Note: Either "FromReleaseId" or "FromReleaseNum" should be specified, but not both. Either "ToReleaseId" or "ToReleaseNum" should be specified, but not both.

Declaration

Task<List<CcdReleaseEntry>> GetReleaseDiffEntriesAsync(ReleaseDiffOptions releaseDiffOptions, PageOptions pageOptions = null)

Parameters

Type	Name	Description
ReleaseDiffOptions	releaseDiffOptions	Parameters for a release diff.
PageOptions	pageOptions	Pagination options.

Returns

Type	Description
Task<List<CcdReleaseEntry>>	List of CcdReleaseentries of the diff.

Exceptions

Type	Condition
CcdManagementException

GetReleaseEntriesAsync(ReleaseEntryOptions, PageOptions)

Async Operation. Get release entries. Required: BucketId, ReleaseId.

Declaration

Task<List<CcdReleaseEntry>> GetReleaseEntriesAsync(ReleaseEntryOptions releaseEntryOptions, PageOptions pageOptions = null)

Parameters

Type	Name	Description
ReleaseEntryOptions	releaseEntryOptions	Parameters for release entries.
PageOptions	pageOptions	Pagination options.

Returns

Type	Description
Task<List<CcdReleaseEntry>>	List of CcdReleaseentries for a specified release.

Exceptions

Type	Condition
CcdManagementException

GetReleaseEntriesByBadgeAsync(ReleaseByBadgeOptions, PageOptions)

Async Operation. Get badged release entries. Required: BucketId, BadgeName.

Declaration

Task<List<CcdReleaseEntry>> GetReleaseEntriesByBadgeAsync(ReleaseByBadgeOptions releaseByBadgeOptions, PageOptions pageOptions = null)

Parameters

Type	Name	Description
ReleaseByBadgeOptions	releaseByBadgeOptions	Parameters for release entries by badge.
PageOptions	pageOptions	Pagination options.

Returns

Type	Description
Task<List<CcdReleaseEntry>>	List of CcdReleaseentries for a specified badged release.

Exceptions

Type	Condition
CcdManagementException

GetReleasesAsync(Guid, PageOptions)

Async Operation. Get releases for bucket.

Declaration

Task<List<CcdRelease>> GetReleasesAsync(Guid bucketId, PageOptions pageOptions = null)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
PageOptions	pageOptions	Pagination options.

Returns

Type	Description
Task<List<CcdRelease>>	List of CcdReleases for the specified bucket.

Exceptions

Type	Condition
CcdManagementException

GetStatsAsync(ReleaseStatsOptions)

Async Operation. Get stats for a release. Required: BucketId, ReleaseId, Metric, Interval.

Declaration

Task<CcdMetricQuantity> GetStatsAsync(ReleaseStatsOptions releaseStatsOptions)

Parameters

Type	Name	Description
ReleaseStatsOptions	releaseStatsOptions	Parameters for release stats.

Returns

Type	Description
Task<CcdMetricQuantity>	CcdMetricQuantity for the specified release.

Exceptions

Type	Condition
CcdManagementException

GetUserApiKeyAsync()

Async Operation. Get user API key.

Declaration

Task<CcdUserAPIKey> GetUserApiKeyAsync()

Returns

Type	Description
Task<CcdUserAPIKey>	User api key

Exceptions

Type	Condition
CcdManagementException

GetUserInfoAsync()

Async Operation. Get user info.

Declaration

Task<CcdUser> GetUserInfoAsync()

Returns

Type	Description
Task<CcdUser>	User Info

Exceptions

Type	Condition
CcdManagementException

ListBadgesAsync(Guid, PageOptions)

Async Operation. Get badges.

Declaration

Task<List<CcdBadge>> ListBadgesAsync(Guid bucketId, PageOptions pageOptions = null)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
PageOptions	pageOptions	Pagination options.

Returns

Type	Description
Task<List<CcdBadge>>	List of CcdBadges.

Exceptions

Type	Condition
CcdManagementException

ListBucketsAsync(PageOptions, ListBucketsOptions)

Async Operation. Get buckets for project.

Declaration

Task<List<CcdBucket>> ListBucketsAsync(PageOptions pageOptions = null, ListBucketsOptions listBucketsOptions = null)

Parameters

Type	Name	Description
PageOptions	pageOptions	Pagination options.
ListBucketsOptions	listBucketsOptions	Parameters for listing the project buckets.

Returns

Type	Description
Task<List<CcdBucket>>	List of CcdBuckets.

Exceptions

Type	Condition
CcdManagementException

ListEnvironmentsByProjectAsync(Guid, PageOptions)

Async Operation. Get lists of environments for a project

Declaration

Task<List<CcdEnvironment>> ListEnvironmentsByProjectAsync(Guid projectId, PageOptions pageOptions = null)

Parameters

Type	Name	Description
Guid	projectId	Id of the project.
PageOptions	pageOptions	Pagination options.

Returns

Type	Description
Task<List<CcdEnvironment>>	List of environemnts for a project

Exceptions

Type	Condition
CcdManagementException

PromoteBucketAsync(PromoteBucketOptions)

Async Operation. Promote release between buckets. Required: BucketId, FromRelease.

Declaration

Task<CcdRelease> PromoteBucketAsync(PromoteBucketOptions promoteBucketOptions)

Parameters

Type	Name	Description
PromoteBucketOptions	promoteBucketOptions	Parameters for promoting a bucket.

Returns

Type	Description
Task<CcdRelease>	CcdRelease that was promoted.

Exceptions

Type	Condition
CcdManagementException

RegenerateUserApiKeyAsync()

Async Operation. Re-generate user API key.

Declaration

Task<CcdUserAPIKey> RegenerateUserApiKeyAsync()

Returns

Type	Description
Task<CcdUserAPIKey>	User api key

Exceptions

Type	Condition
CcdManagementException

UpdateBucketAsync(UpdateBucketOptions)

Async Operation. Update a bucket.

Declaration

Task<CcdBucket> UpdateBucketAsync(UpdateBucketOptions updateBucketOptions)

Parameters

Type	Name	Description
UpdateBucketOptions	updateBucketOptions	Parameters for updating a bucket.

Returns

Type	Description
Task<CcdBucket>	CcdBucket that was updated.

Exceptions

Type	Condition
CcdManagementException

UpdateEntryAsync(EntryOptions, EntryModelOptions)

Async Operation. Update entry. Required: BucketId, EntryId.

Declaration

Task<CcdEntry> UpdateEntryAsync(EntryOptions entryOptions, EntryModelOptions entry)

Parameters

Type	Name	Description
EntryOptions	entryOptions	Parameters for the entry.
EntryModelOptions	entry	Properties to update for the entry.

Returns

Type	Description
Task<CcdEntry>	CcdEntry that was updated.

Exceptions

Type	Condition
CcdManagementException

UpdateEntryByPathAsync(EntryByPathOptions, EntryModelOptions)

Async Operation. Update entry by path. Required: BucketId, Path.

Declaration

Task<CcdEntry> UpdateEntryByPathAsync(EntryByPathOptions entryByPathOptions, EntryModelOptions entry)

Parameters

Type	Name	Description
EntryByPathOptions	entryByPathOptions	Parameters for the entry by path.
EntryModelOptions	entry	Properties to update for the entry.

Returns

Type	Description
Task<CcdEntry>	CcdEntry that was updated.

Exceptions

Type	Condition
CcdManagementException

UpdatePermissionAsync(UpdatePermissionsOption)

Async Operation. Update a permission. Required: BucketId, Action, Permission.

Declaration

Task<CcdPermission> UpdatePermissionAsync(UpdatePermissionsOption permissionsOptions)

Parameters

Type	Name	Description
UpdatePermissionsOption	permissionsOptions	Parameters for updating a permission.

Returns

Type	Description
Task<CcdPermission>	CcdPermission that was updated.

Exceptions

Type	Condition
CcdManagementException

UpdateReleaseAsync(Guid, Guid, string)

Async Operation. Update release.

Declaration

Task<CcdRelease> UpdateReleaseAsync(Guid bucketId, Guid releaseId, string notes)

Parameters

Type	Name	Description
Guid	bucketId	Id of the bucket.
Guid	releaseId	Id of the release.
string	notes	Notes to update.

Returns

Type	Description
Task<CcdRelease>	CcdRelease that was updated.

Exceptions

Type	Condition
CcdManagementException

UploadContentAsync(UploadContentOptions)

Async Operation. Upload content for entry. Required: BucketId, EntryId, File.

Declaration

Task UploadContentAsync(UploadContentOptions uploadContentOptions)

Parameters

Type	Name	Description
UploadContentOptions	uploadContentOptions	Parameters for uploading content.

Returns

Type	Description
Task	Awaitable task.

Exceptions

Type	Condition
CcdManagementException