Class CCDPublisher

Publisher used to publish build artifacts to CCD

Inheritance
Object
AbstractPublisher
CCDPublisher
Inherited Members
Namespace: Unity.Industrial.Forma.Core.Publishing.Publishers.CCD
Syntax
[Publisher(0)]
[Serializable]
public class CCDPublisher : AbstractPublisher

Properties

ApiKey

The API key of user's Cloud Content Delivery account

Declaration
public string ApiKey { get; set; }
Property Value
Type Description
String

AvailableBuckets

Buckets currently available on CCD

Declaration
public IReadOnlyList<CCDUtils.BucketData> AvailableBuckets { get; }
Property Value
Type Description
IReadOnlyList<CCDUtils.BucketData>

Bucket

The ID of the Cloud Content Delivery Bucket to use

Declaration
public CCDUtils.BucketData Bucket { get; set; }
Property Value
Type Description
CCDUtils.BucketData

DisplayName

The end-point's name

Declaration
public override string DisplayName { get; }
Property Value
Type Description
String
Overrides

ProjectID

The ID of the Cloud Content Delivery Project to use

Declaration
public string ProjectID { get; set; }
Property Value
Type Description
String

Methods

CanPublishAsync(BuildProfile, String, Boolean)

Check if the Publisher can publish runtime.

Declaration
public override async Task<bool> CanPublishAsync(BuildProfile buildProfile, string buildFolder, bool showLogs = false)
Parameters
Type Name Description
BuildProfile buildProfile

Build profile used to publish product

String buildFolder

Path to folder containing runtime build

Boolean showLogs

Whether or not errors should be printed to the Console

Returns
Type Description
Task<Boolean>

Whether or not publisher can publish runtime

Overrides

CanPublishAsync(BuildProfile, Product, String, Boolean)

Check if the Publisher can publish product.

Declaration
public override async Task<bool> CanPublishAsync(BuildProfile buildProfile, Product product, string aaFolder, bool showLogs = false)
Parameters
Type Name Description
BuildProfile buildProfile

Build profile used to publish product

Product product

Product to be published

String aaFolder

Path to folder containing aa and catalog

Boolean showLogs

Whether or not errors should be printed to the Console

Returns
Type Description
Task<Boolean>

Whether or not publisher can publish product

Overrides

CreateNewBucket(String, String)

Create bucket on CCD with given name and description.

Declaration
public CCDUtils.BucketData CreateNewBucket(string bucketName, string bucketDescription = "")
Parameters
Type Name Description
String bucketName

Bucket name

String bucketDescription
Returns
Type Description
CCDUtils.BucketData

Created bucket

PublishProductAsync(BuildProfile, Product, String, String, Boolean)

Try to publish product using passed data.

Declaration
public override Task PublishProductAsync(BuildProfile buildProfile, Product product, string aaFolder, string address, bool showLogs = false)
Parameters
Type Name Description
BuildProfile buildProfile

Build profile used to publish product

Product product

Product to be published

String aaFolder

Path to folder containing aa and catalog

String address

Addressable address of the product

Boolean showLogs

Whether or not errors should be printed to the Console

Returns
Type Description
Task

Whether or not publish was successful

Overrides

PublishRuntimeAsync(BuildProfile, String, Boolean)

Try to publish build at path using passed data.

Declaration
public override Task PublishRuntimeAsync(BuildProfile buildProfile, string buildFolder, bool showLogs = false)
Parameters
Type Name Description
BuildProfile buildProfile

Build profile used to publish product

String buildFolder

Path to folder containing build content

Boolean showLogs

Whether or not errors should be printed to the Console

Returns
Type Description
Task

Whether or not publish was successful

Overrides