Package io.temporal.api.cloud.namespace.v1

Interface NamespaceSpecOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    NamespaceSpec, NamespaceSpec.Builder
    @Generated(value="protoc",
           comments="annotations:NamespaceSpecOrBuilder.java.pb.meta")
public interface NamespaceSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        java.lang.String getName()
         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.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         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.
        string name = 1;
        Returns:
        The bytes for name.

      • getRegionsList

        java.util.List<java.lang.String> getRegionsList()
         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"].
        repeated string regions = 2;
        Returns:
        A list containing the regions.

      • getRegionsCount

        int getRegionsCount()
         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"].
        repeated string regions = 2;
        Returns:
        The count of regions.

      • getRegions

        java.lang.String getRegions​(int index)
         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"].
        repeated string regions = 2;
        Parameters:
        index - The index of the element to return.
        Returns:
        The regions at the given index.

      • getRegionsBytes

        com.google.protobuf.ByteString getRegionsBytes​(int index)
         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"].
        repeated string regions = 2;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the regions at the given index.

      • getRetentionDays

        int getRetentionDays()
         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.
        int32 retention_days = 3;
        Returns:
        The retentionDays.

      • hasMtlsAuth

        boolean hasMtlsAuth()
         The mTLS auth configuration for the namespace.
 If unspecified, mTLS will be disabled.
        .temporal.api.cloud.namespace.v1.MtlsAuthSpec mtls_auth = 4;
        Returns:
        Whether the mtlsAuth field is set.

      • getMtlsAuth

        MtlsAuthSpec getMtlsAuth()
         The mTLS auth configuration for the namespace.
 If unspecified, mTLS will be disabled.
        .temporal.api.cloud.namespace.v1.MtlsAuthSpec mtls_auth = 4;
        Returns:
        The mtlsAuth.

      • getMtlsAuthOrBuilder

        MtlsAuthSpecOrBuilder getMtlsAuthOrBuilder()
         The mTLS auth configuration for the namespace.
 If unspecified, mTLS will be disabled.
        .temporal.api.cloud.namespace.v1.MtlsAuthSpec mtls_auth = 4;

      • hasApiKeyAuth

        boolean hasApiKeyAuth()
         The API key auth configuration for the namespace.
 If unspecified, API keys will be disabled.
 temporal:versioning:min_version=2024-05-13-00
        .temporal.api.cloud.namespace.v1.ApiKeyAuthSpec api_key_auth = 7;
        Returns:
        Whether the apiKeyAuth field is set.

      • getApiKeyAuth

        ApiKeyAuthSpec getApiKeyAuth()
         The API key auth configuration for the namespace.
 If unspecified, API keys will be disabled.
 temporal:versioning:min_version=2024-05-13-00
        .temporal.api.cloud.namespace.v1.ApiKeyAuthSpec api_key_auth = 7;
        Returns:
        The apiKeyAuth.

      • getApiKeyAuthOrBuilder

        ApiKeyAuthSpecOrBuilder getApiKeyAuthOrBuilder()
         The API key auth configuration for the namespace.
 If unspecified, API keys will be disabled.
 temporal:versioning:min_version=2024-05-13-00
        .temporal.api.cloud.namespace.v1.ApiKeyAuthSpec api_key_auth = 7;

      • getCustomSearchAttributesCount

        int getCustomSearchAttributesCount()
         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.
        map<string, string> custom_search_attributes = 5;

      • containsCustomSearchAttributes

        boolean containsCustomSearchAttributes​(java.lang.String key)
         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.
        map<string, string> custom_search_attributes = 5;

      • getCustomSearchAttributes

        @Deprecated
java.util.Map<java.lang.String,​java.lang.String> getCustomSearchAttributes()
        Deprecated.
        Use getCustomSearchAttributesMap() instead.

      • getCustomSearchAttributesMap

        java.util.Map<java.lang.String,​java.lang.String> getCustomSearchAttributesMap()
         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.
        map<string, string> custom_search_attributes = 5;

      • getCustomSearchAttributesOrDefault

        java.lang.String getCustomSearchAttributesOrDefault​(java.lang.String key,
                                                    java.lang.String defaultValue)
         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.
        map<string, string> custom_search_attributes = 5;

      • getCustomSearchAttributesOrThrow

        java.lang.String getCustomSearchAttributesOrThrow​(java.lang.String key)
         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.
        map<string, string> custom_search_attributes = 5;

      • hasCodecServer

        boolean hasCodecServer()
         Codec server spec used by UI to decode payloads for all users interacting with this namespace.
 Optional, default is unset.
        .temporal.api.cloud.namespace.v1.CodecServerSpec codec_server = 6;
        Returns:
        Whether the codecServer field is set.

      • getCodecServer

        CodecServerSpec getCodecServer()
         Codec server spec used by UI to decode payloads for all users interacting with this namespace.
 Optional, default is unset.
        .temporal.api.cloud.namespace.v1.CodecServerSpec codec_server = 6;
        Returns:
        The codecServer.

      • getCodecServerOrBuilder

        CodecServerSpecOrBuilder getCodecServerOrBuilder()
         Codec server spec used by UI to decode payloads for all users interacting with this namespace.
 Optional, default is unset.
        .temporal.api.cloud.namespace.v1.CodecServerSpec codec_server = 6;