Interface ICCDReleasesApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.CloudContentDelivery

Assembly: solution.dll

Syntax

public interface ICCDReleasesApi : IApiAccessor

Methods

GetReleaseByBadgePublic(string, string, CancellationToken)

Get badged release

Declaration

[Obsolete]
ApiOperation<Release> GetReleaseByBadgePublic(string bucketid, string badgename, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	bucketid	Bucket ID
string	badgename	Badge Name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<Release>	The operation

GetReleaseByBadgePublicEnv(string, string, string, CancellationToken)

Get badged release

Declaration

ApiOperation<Release> GetReleaseByBadgePublicEnv(string environmentname, string bucketid, string badgename, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	environmentname	Environment Name
string	bucketid	Bucket ID
string	badgename	Badge Name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<Release>	The operation

GetReleaseDiff(string, string, long?, string, long?, CancellationToken)

Get counts of changes between releases

Declaration

[Obsolete]
ApiOperation<Changecount> GetReleaseDiff(string bucketid, string fromreleaseid = null, long? fromreleasenum = null, string toreleaseid = null, long? toreleasenum = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	bucketid	Bucket ID
string	fromreleaseid	From Release ID, specify 'latest' to use the most recent release. Either fromreleaseid or fromreleasenum can be specified, but not both. (optional)
long?	fromreleasenum	From Release Number. To query against an empty bucket you may set fromreleasenum to zero. Either fromreleaseid or fromreleasenum can be specified, but not both. (optional)
string	toreleaseid	To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both. (optional)
long?	toreleasenum	To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<Changecount>	The operation

GetReleaseDiffEntries(string, string, long?, string, long?, long?, int?, string, List<string>, string, string, bool?, string, string, CancellationToken)

Get changed entries between releases

Declaration

[Obsolete]
ApiOperation<List<Releaseentry>> GetReleaseDiffEntries(string bucketid, string fromreleaseid = null, long? fromreleasenum = null, string toreleaseid = null, long? toreleasenum = null, long? page = null, int? perPage = null, string path = null, List<string> includeStates = null, string contentType = null, string label = null, bool? complete = null, string sortBy = null, string sortOrder = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	bucketid	Bucket ID
string	fromreleaseid	From Release ID, specify 'latest' to use the most recent release. Either fromreleaseid or fromreleasenum can be specified, but not both. (optional)
long?	fromreleasenum	From Release Number. To query against an empty bucket you may set fromreleasenum to zero. Either fromreleaseid or fromreleasenum can be specified, but not both. (optional)
string	toreleaseid	To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both. (optional)
long?	toreleasenum	To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both. (optional)
long?	page	Current Page (optional)
int?	perPage	Items Per Page (optional, default to 10)
string	path	Path (optional)
List<string>	includeStates	Include change states, one or more can be specified. The default is all states. (optional)
string	contentType	content type (optional)
string	label	Label (optional)
bool?	complete	is content upload completed or not (optional)
string	sortBy	Sort By (optional)
string	sortOrder	Sort Order (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<Releaseentry>>	The operation

GetReleaseDiffEntriesEnv(string, string, string, long?, string, long?, long?, int?, string, List<string>, string, string, bool?, string, string, CancellationToken)

Get changed entries between releases

Declaration

ApiOperation<List<Releaseentry>> GetReleaseDiffEntriesEnv(string environmentname, string bucketid, string fromreleaseid = null, long? fromreleasenum = null, string toreleaseid = null, long? toreleasenum = null, long? page = null, int? perPage = null, string path = null, List<string> includeStates = null, string contentType = null, string label = null, bool? complete = null, string sortBy = null, string sortOrder = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	environmentname	Environment Name
string	bucketid	Bucket ID
string	fromreleaseid	From Release ID, specify 'latest' to use the most recent release. Either fromreleaseid or fromreleasenum can be specified, but not both. (optional)
long?	fromreleasenum	From Release Number. To query against an empty bucket you may set fromreleasenum to zero. Either fromreleaseid or fromreleasenum can be specified, but not both. (optional)
string	toreleaseid	To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both. (optional)
long?	toreleasenum	To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both. (optional)
long?	page	Current Page (optional)
int?	perPage	Items Per Page (optional, default to 10)
string	path	Path (optional)
List<string>	includeStates	Include change states, one or more can be specified. The default is all states. (optional)
string	contentType	content type (optional)
string	label	Label (optional)
bool?	complete	is content upload completed or not (optional)
string	sortBy	Sort By (optional)
string	sortOrder	Sort Order (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<Releaseentry>>	The operation

GetReleaseDiffEnv(string, string, string, long?, string, long?, CancellationToken)

Get counts of changes between releases

Declaration

ApiOperation<Changecount> GetReleaseDiffEnv(string environmentname, string bucketid, string fromreleaseid = null, long? fromreleasenum = null, string toreleaseid = null, long? toreleasenum = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	environmentname	Environment Name
string	bucketid	Bucket ID
string	fromreleaseid	From Release ID, specify 'latest' to use the most recent release. Either fromreleaseid or fromreleasenum can be specified, but not both. (optional)
long?	fromreleasenum	From Release Number. To query against an empty bucket you may set fromreleasenum to zero. Either fromreleaseid or fromreleasenum can be specified, but not both. (optional)
string	toreleaseid	To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both. (optional)
long?	toreleasenum	To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<Changecount>	The operation

GetReleaseEntries(string, string, string, long?, int?, CancellationToken)

Get release entries

Declaration

[Obsolete]
ApiOperation<List<Releaseentry>> GetReleaseEntries(string bucketid, string releaseid, string label = null, long? page = null, int? perPage = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	bucketid	Bucket ID
string	releaseid	Release ID
string	label	Label (optional)
long?	page	Current Page (optional)
int?	perPage	Items Per Page (optional, default to 10)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<Releaseentry>>	The operation

GetReleaseEntriesEnv(string, string, string, string, long?, int?, CancellationToken)

Get release entries

Declaration

ApiOperation<List<Releaseentry>> GetReleaseEntriesEnv(string environmentname, string bucketid, string releaseid, string label = null, long? page = null, int? perPage = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	environmentname	Environment Name
string	bucketid	Bucket ID
string	releaseid	Release ID
string	label	Label (optional)
long?	page	Current Page (optional)
int?	perPage	Items Per Page (optional, default to 10)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<Releaseentry>>	The operation

GetReleasePublic(string, string, CancellationToken)

Get release

Declaration

[Obsolete]
ApiOperation<Release> GetReleasePublic(string bucketid, string releaseid, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	bucketid	Bucket ID
string	releaseid	Release ID
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<Release>	The operation

GetReleasePublicEnv(string, string, string, CancellationToken)

Get release

Declaration

ApiOperation<Release> GetReleasePublicEnv(string environmentname, string bucketid, string releaseid, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	environmentname	Environment Name
string	bucketid	Bucket ID
string	releaseid	Release ID
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<Release>	The operation

GetReleases(string, long?, int?, string, string, string, string, string, string, string, CancellationToken)

Get releases for bucket

Declaration

[Obsolete]
ApiOperation<List<GetReleases200ResponseInner>> GetReleases(string bucketid, long? page = null, int? perPage = null, string releasenum = null, string notes = null, string promotedFromBucket = null, string promotedFromRelease = null, string badges = null, string sortBy = null, string sortOrder = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	bucketid	Bucket ID
long?	page	Current Page (optional)
int?	perPage	Items Per Page (optional, default to 10)
string	releasenum	release number (optional)
string	notes	Release notes (optional)
string	promotedFromBucket	Bucket where release promoted from. (optional)
string	promotedFromRelease	Release where release promoted from. (optional)
string	badges	Badge names. (optional)
string	sortBy	Sort By (optional)
string	sortOrder	Sort Order (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<GetReleases200ResponseInner>>	The operation

GetReleasesEnv(string, string, long?, int?, string, string, string, string, string, string, string, CancellationToken)

Get releases for bucket

Declaration

ApiOperation<List<GetReleases200ResponseInner>> GetReleasesEnv(string environmentname, string bucketid, long? page = null, int? perPage = null, string releasenum = null, string notes = null, string promotedFromBucket = null, string promotedFromRelease = null, string badges = null, string sortBy = null, string sortOrder = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	environmentname	Environment Name
string	bucketid	Bucket ID
long?	page	Current Page (optional)
int?	perPage	Items Per Page (optional, default to 10)
string	releasenum	release number (optional)
string	notes	Release notes (optional)
string	promotedFromBucket	Bucket where release promoted from. (optional)
string	promotedFromRelease	Release where release promoted from. (optional)
string	badges	Badge names. (optional)
string	sortBy	Sort By (optional)
string	sortOrder	Sort Order (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<GetReleases200ResponseInner>>	The operation