Class MultiplayBuildsBuildInstall

A single build install within the Build Installs List response

Inheritance

object

MultiplayBuildsBuildInstall

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.Admin.Multiplay

Assembly: Unity.Services.Apis.dll

Syntax

[DataContract(Name = "multiplay.builds.buildInstall")]
[Preserve]
public class MultiplayBuildsBuildInstall

Constructors

MultiplayBuildsBuildInstall(string, MultiplayBuildsCcdDetails, string, long, MultiplayBuildsContainer, List<MultiplayBuildsBuildInstallFailure>, string, long, List<MultiplayBuildsBuildInstallRegions>)

Initializes a new instance of the MultiplayBuildsBuildInstall class.

Declaration

[Preserve]
public MultiplayBuildsBuildInstall(string buildVersionName = null, MultiplayBuildsCcdDetails ccd = null, string ccdBucketID = null, long completedMachines = 0, MultiplayBuildsContainer container = null, List<MultiplayBuildsBuildInstallFailure> failures = null, string fleetName = null, long pendingMachines = 0, List<MultiplayBuildsBuildInstallRegions> regions = null)

Parameters

Type	Name	Description
string	buildVersionName	The name of the build's current version. However, it is not relevant for container builds, in which the 'imageTag' is used instead. (required).
MultiplayBuildsCcdDetails	ccd	ccd.
string	ccdBucketID	The CCD bucket ID for a build within an environment..
long	completedMachines	The total number of completed machines within a fleet for a build install. (required).
MultiplayBuildsContainer	container	container.
List<MultiplayBuildsBuildInstallFailure>	failures	A list of install failures for this build (required).
string	fleetName	The name of a fleet for a build install. (required).
long	pendingMachines	The total number of pending machines within a fleet for a build install. (required).
List<MultiplayBuildsBuildInstallRegions>	regions	A list of build installs by region within a fleet for a build install. (required).

Properties

BuildVersionName

The name of the build's current version. However, it is not relevant for container builds, in which the 'imageTag' is used instead.

Declaration

[DataMember(Name = "buildVersionName", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string BuildVersionName { get; set; }

Property Value

Type	Description
string	The name of the build's current version. However, it is not relevant for container builds, in which the 'imageTag' is used instead.

Ccd

Gets or Sets Ccd

Declaration

[DataMember(Name = "ccd", EmitDefaultValue = false)]
[Preserve]
public MultiplayBuildsCcdDetails Ccd { get; set; }

Property Value

Type	Description
MultiplayBuildsCcdDetails

CcdBucketID

The CCD bucket ID for a build within an environment.

Declaration

[DataMember(Name = "ccdBucketID", EmitDefaultValue = false)]
[Obsolete]
[Preserve]
public string CcdBucketID { get; set; }

Property Value

Type	Description
string	The CCD bucket ID for a build within an environment.

CompletedMachines

The total number of completed machines within a fleet for a build install.

Declaration

[DataMember(Name = "completedMachines", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long CompletedMachines { get; set; }

Property Value

Type	Description
long	The total number of completed machines within a fleet for a build install.

Container

Gets or Sets Container

Declaration

[DataMember(Name = "container", EmitDefaultValue = false)]
[Preserve]
public MultiplayBuildsContainer Container { get; set; }

Property Value

Type	Description
MultiplayBuildsContainer

Failures

A list of install failures for this build

Declaration

[DataMember(Name = "failures", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public List<MultiplayBuildsBuildInstallFailure> Failures { get; set; }

Property Value

Type	Description
List<MultiplayBuildsBuildInstallFailure>	A list of install failures for this build

FleetName

The name of a fleet for a build install.

Declaration

[DataMember(Name = "fleetName", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string FleetName { get; set; }

Property Value

Type	Description
string	The name of a fleet for a build install.

PendingMachines

The total number of pending machines within a fleet for a build install.

Declaration

[DataMember(Name = "pendingMachines", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public long PendingMachines { get; set; }

Property Value

Type	Description
long	The total number of pending machines within a fleet for a build install.

Regions

A list of build installs by region within a fleet for a build install.

Declaration

[DataMember(Name = "regions", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public List<MultiplayBuildsBuildInstallRegions> Regions { get; set; }

Property Value

Type	Description
List<MultiplayBuildsBuildInstallRegions>	A list of build installs by region within a fleet for a build install.