Class AllocationRequest

A request to create an allocation.

Inheritance

object

AllocationRequest

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.Relay

Assembly: Unity.Services.Apis.dll

Syntax

[DataContract(Name = "AllocationRequest")]
[Preserve]
public class AllocationRequest

Constructors

AllocationRequest(int, string)

Initializes a new instance of the AllocationRequest class.

Declaration

[Preserve]
public AllocationRequest(int maxConnections = 0, string region = null)

Parameters

Type	Name	Description
int	maxConnections	The maximum number of peer connections allowed for this allocation. The Allocations service also uses this number to find a Relay with sufficient capacity. (required).
string	region	The region in which to create this allocation. Get a list of supported values from the /regions endpoint or omit this parameter to use the default region..

Properties

MaxConnections

The maximum number of peer connections allowed for this allocation. The Allocations service also uses this number to find a Relay with sufficient capacity.

Declaration

[DataMember(Name = "maxConnections", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public int MaxConnections { get; set; }

Property Value

Type	Description
int	The maximum number of peer connections allowed for this allocation. The Allocations service also uses this number to find a Relay with sufficient capacity.

Region

The region in which to create this allocation. Get a list of supported values from the /regions endpoint or omit this parameter to use the default region.

Declaration

[DataMember(Name = "region", EmitDefaultValue = false)]
[Preserve]
public string Region { get; set; }

Property Value

Type	Description
string	The region in which to create this allocation. Get a list of supported values from the /regions endpoint or omit this parameter to use the default region.