Class NamespaceSpec

Namespace

Temporalio.Api.Cloud.Namespace.V1

Assembly

Temporalio.dll

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

Inheritance

object

NamespaceSpec

Implements

IMessage<NamespaceSpec>

IEquatable<NamespaceSpec>

IDeepCloneable<NamespaceSpec>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

NamespaceSpec()

public NamespaceSpec()

NamespaceSpec(NamespaceSpec)

public NamespaceSpec(NamespaceSpec other)

Parameters

other NamespaceSpec

Fields

ApiKeyAuthFieldNumber

Field number for the "api_key_auth" field.

public const int ApiKeyAuthFieldNumber = 7

Field Value

int

CodecServerFieldNumber

Field number for the "codec_server" field.

public const int CodecServerFieldNumber = 6

Field Value

int

CustomSearchAttributesFieldNumber

Field number for the "custom_search_attributes" field.

public const int CustomSearchAttributesFieldNumber = 5

Field Value

int

MtlsAuthFieldNumber

Field number for the "mtls_auth" field.

public const int MtlsAuthFieldNumber = 4

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 1

Field Value

int

RegionsFieldNumber

Field number for the "regions" field.

public const int RegionsFieldNumber = 2

Field Value

int

RetentionDaysFieldNumber

Field number for the "retention_days" field.

public const int RetentionDaysFieldNumber = 3

Field Value

int

Properties

ApiKeyAuth

The API key auth configuration for the namespace. If unspecified, API keys will be disabled. temporal:versioning:min_version=2024-05-13-00

public ApiKeyAuthSpec ApiKeyAuth { get; set; }

Property Value

ApiKeyAuthSpec

CodecServer

Codec server spec used by UI to decode payloads for all users interacting with this namespace. Optional, default is unset.

public CodecServerSpec CodecServer { get; set; }

Property Value

CodecServerSpec

CustomSearchAttributes

The custom search attributes to use for the namespace. The name of the attribute is the key and the type is the value. Supported attribute types: text, keyword, int, double, bool, datetime, keyword_list. NOTE: currently deleting a search attribute is not supported. Optional, default is empty.

public MapField<string, string> CustomSearchAttributes { get; }

Property Value

MapField<string, string>

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

MtlsAuth

The mTLS auth configuration for the namespace. If unspecified, mTLS will be disabled.

public MtlsAuthSpec MtlsAuth { get; set; }

Property Value

MtlsAuthSpec

Name

The name to use for the namespace. This will create a namespace that's available at '<name>.<account>.tmprl.cloud:7233'. The name is immutable. Once set, it cannot be changed.

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<NamespaceSpec> Parser { get; }

Property Value

MessageParser<NamespaceSpec>

Regions

The ids of the regions where the namespace should be available. The GetRegions API can be used to get the list of valid region ids. Specifying more than one region makes the namespace "global", which is currently a preview only feature with restricted access. Please reach out to Temporal support for more information on global namespaces. When provisioned the global namespace will be active on the first region in the list and passive on the rest. Number of supported regions is 2. The regions is immutable. Once set, it cannot be changed. Example: ["aws-us-west-2"].

public RepeatedField<string> Regions { get; }

Property Value

RepeatedField<string>

RetentionDays

The number of days the workflows data will be retained for. Changes to the retention period may impact your storage costs. Any changes to the retention period will be applied to all new running workflows.

public int RetentionDays { get; set; }

Property Value

int

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 NamespaceSpec Clone()

Returns

NamespaceSpec

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(NamespaceSpec)

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

public bool Equals(NamespaceSpec other)

Parameters

other NamespaceSpec

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(NamespaceSpec)

Merges the given message into this one.

public void MergeFrom(NamespaceSpec other)

Parameters

other NamespaceSpec

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.