Class RestServerAgent

Namespace

Kepware.Api.Model

Assembly

Kepware.Api.dll

Represents a REST Server agent in the IoT Gateway. REST Server agents do not have publish or message template properties.

[Endpoint("/config/v1/project/_iot_gateway/rest_servers/{name}", null)]
public class RestServerAgent : IotAgent, IEquatable<BaseEntity>, IHaveOwner, IHaveName

Inheritance

object

BaseEntity

DefaultEntity

NamedEntity

IotAgent

RestServerAgent

Implements

IEquatable<BaseEntity>

IHaveOwner

IHaveName

Inherited Members

IotAgent.IotItems

IotAgent.AgentType

IotAgent.Enabled

IotAgent.IgnoreQualityChanges

IotAgent.ThisAgentTotal

IotAgent.AllAgentsTotal

IotAgent.LicenseLimit

IotAgent.Cleanup(IKepwareDefaultValueProvider, bool, CancellationToken)

NamedEntity.Name

NamedEntity.AppendHashSources(CustomHashGenerator.HashSourceBuilder)

NamedEntity.GetUpdateDiff(NamedEntity, bool)

DefaultEntity.Owner

BaseEntity.IncludesNestedDynamicProperties

BaseEntity.Hash

BaseEntity.ProjectId

BaseEntity.Description

BaseEntity.TypeName

BaseEntity.DynamicProperties

BaseEntity.Equals(BaseEntity)

BaseEntity.GetDynamicProperty<T>(string)

BaseEntity.SetDynamicProperty<T>(string, T)

BaseEntity.TryGetDynamicProperty<T>(string, out T)

BaseEntity.CalculateHash()

BaseEntity.EnsureDynamicPropertiesNormalized()

BaseEntity.NormalizeNestedProperties()

BaseEntity.ConditionalNonSerialized()

BaseEntity.GetUpdateDiff(DefaultEntity)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

HelperExtentions.Flatten(NamedEntity?)

HelperExtentions.Flatten(NamedEntity?, Type)

Constructors

RestServerAgent()

Initializes a new instance of the RestServerAgent class.

RestServerAgent(string)

Initializes a new instance of the RestServerAgent class with the specified name.

Properties

AllowAnonymousLogin

Gets or sets whether anonymous login is allowed.

CorsAllowedOrigins

Gets or sets the CORS allowed origins (comma-delimited list).

EnableWriteEndpoint

Gets or sets whether the write endpoint is enabled.

NetworkAdapter

Gets or sets the network adapter for the REST server endpoint.

PortNumber

Gets or sets the port number for the REST server.

UseHttps

Gets or sets whether HTTPS encryption is enabled.