Skip to main content

NamespaceSpec

Struct NamespaceSpec 

Source
pub struct NamespaceSpec {
    pub name: String,
    pub regions: Vec<String>,
    pub retention_days: i32,
    pub mtls_auth: Option<MtlsAuthSpec>,
    pub api_key_auth: Option<ApiKeyAuthSpec>,
    pub custom_search_attributes: HashMap<String, String>,
    pub search_attributes: HashMap<String, i32>,
    pub codec_server: Option<CodecServerSpec>,
    pub lifecycle: Option<LifecycleSpec>,
    pub high_availability: Option<HighAvailabilitySpec>,
    pub connectivity_rule_ids: Vec<String>,
}

Fields§

§name: String

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

§regions: Vec<String>

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”].

§retention_days: i32

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.

§mtls_auth: Option<MtlsAuthSpec>

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

§api_key_auth: Option<ApiKeyAuthSpec>

The API key auth configuration for the namespace. If unspecified, API keys will be disabled. temporal:versioning:min_version=v0.2.0

§custom_search_attributes: HashMap<String, String>

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. Deprecated: Not supported after v0.3.0 api version. Use search_attributes instead. temporal:versioning:max_version=v0.3.0

§search_attributes: HashMap<String, i32>

The custom search attributes to use for the namespace. The name of the attribute is the key and the type is the value. Note: currently deleting a search attribute is not supported. Optional, default is empty. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=custom_search_attributes

§codec_server: Option<CodecServerSpec>

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

§lifecycle: Option<LifecycleSpec>

The lifecycle configuration for the namespace. temporal:versioning:min_version=v0.4.0

§high_availability: Option<HighAvailabilitySpec>

The high availability configuration for the namespace. temporal:versioning:min_version=v0.4.0

§connectivity_rule_ids: Vec<String>

The private connectivity configuration for the namespace. This will apply the connectivity rules specified to the namespace. temporal:versioning:min_version=v0.6.0

Implementations§

Source§

impl NamespaceSpec

Source

pub fn get_search_attributes(&self, key: &str) -> Option<SearchAttributeType>

Returns the enum value for the corresponding key in search_attributes, or None if the entry does not exist or it is not a valid enum value.

Source

pub fn insert_search_attributes( &mut self, key: String, value: SearchAttributeType, ) -> Option<SearchAttributeType>

Inserts a key value pair into search_attributes.

Trait Implementations§

Source§

impl Clone for NamespaceSpec

Source§

fn clone(&self) -> NamespaceSpec

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for NamespaceSpec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for NamespaceSpec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Message for NamespaceSpec

Source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
Source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message to a buffer. Read more
Source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
Source§

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message with a length-delimiter to a buffer. Read more
Source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.
Source§

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes an instance of the message from a buffer. Read more
Source§

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes a length-delimited instance of the message from the buffer.
Source§

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self. Read more
Source§

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.
Source§

impl Name for NamespaceSpec

Source§

const NAME: &'static str = "NamespaceSpec"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.
Source§

const PACKAGE: &'static str = "temporal.api.cloud.namespace.v1"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.
Source§

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.
Source§

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.
Source§

impl PartialEq for NamespaceSpec

Source§

fn eq(&self, other: &NamespaceSpec) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for NamespaceSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,