Class EndpointSpec

Namespace

Temporalio.Api.Cloud.Nexus.V1

Assembly

Temporalio.dll

public sealed class EndpointSpec : IMessage<EndpointSpec>, IEquatable<EndpointSpec>, IDeepCloneable<EndpointSpec>, IBufferMessage, IMessage

Inheritance

object

EndpointSpec

Implements

IMessage<EndpointSpec>

IEquatable<EndpointSpec>

IDeepCloneable<EndpointSpec>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

EndpointSpec()

public EndpointSpec()

EndpointSpec(EndpointSpec)

public EndpointSpec(EndpointSpec other)

Parameters

other EndpointSpec

Fields

DescriptionFieldNumber

Field number for the "description" field.

public const int DescriptionFieldNumber = 4

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 1

Field Value

int

PolicySpecsFieldNumber

Field number for the "policy_specs" field.

public const int PolicySpecsFieldNumber = 3

Field Value

int

TargetSpecFieldNumber

Field number for the "target_spec" field.

public const int TargetSpecFieldNumber = 2

Field Value

int

Properties

Description

The markdown description of the endpoint - optional.

public string Description { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Name

The name of the endpoint. Must be unique within an account. The name must match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$. This field is mutable.

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<EndpointSpec> Parser { get; }

Property Value

MessageParser<EndpointSpec>

PolicySpecs

The set of policies (e.g. authorization) for the endpoint. Each request's caller must match with at least one of the specs to be accepted by the endpoint. This field is mutable.

public RepeatedField<EndpointPolicySpec> PolicySpecs { get; }

Property Value

RepeatedField<EndpointPolicySpec>

TargetSpec

Indicates where the endpoint should forward received nexus requests to.

public EndpointTargetSpec TargetSpec { get; set; }

Property Value

EndpointTargetSpec

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public EndpointSpec Clone()

Returns

EndpointSpec

A deep clone of this object.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(EndpointSpec)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(EndpointSpec other)

Parameters

other EndpointSpec

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(EndpointSpec)

Merges the given message into this one.

public void MergeFrom(EndpointSpec other)

Parameters

other EndpointSpec

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.