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

Class NamespaceSpec

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NamespaceSpecOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:NamespaceSpec.java.pb.meta")
public final class NamespaceSpec
extends com.google.protobuf.GeneratedMessageV3
implements NamespaceSpecOrBuilder
    Protobuf type temporal.api.cloud.namespace.v1.NamespaceSpec
    See Also:
    Serialized Form

    • Field Detail

      • RETENTION_DAYS_FIELD_NUMBER

        public static final int RETENTION_DAYS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • API_KEY_AUTH_FIELD_NUMBER

        public static final int API_KEY_AUTH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOM_SEARCH_ATTRIBUTES_FIELD_NUMBER

        public static final int CUSTOM_SEARCH_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SEARCH_ATTRIBUTES_FIELD_NUMBER

        public static final int SEARCH_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CODEC_SERVER_FIELD_NUMBER

        public static final int CODEC_SERVER_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapFieldReflection

        protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection​(int number)
        Overrides:
        internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public 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;
        Specified by:
        getName in interface NamespaceSpecOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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;
        Specified by:
        getNameBytes in interface NamespaceSpecOrBuilder
        Returns:
        The bytes for name.

      • getRegionsList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getRegionsList in interface NamespaceSpecOrBuilder
        Returns:
        A list containing the regions.

      • getRegionsCount

        public 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;
        Specified by:
        getRegionsCount in interface NamespaceSpecOrBuilder
        Returns:
        The count of regions.

      • getRegions

        public 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;
        Specified by:
        getRegions in interface NamespaceSpecOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The regions at the given index.

      • getRegionsBytes

        public 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;
        Specified by:
        getRegionsBytes in interface NamespaceSpecOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the regions at the given index.

      • getRetentionDays

        public 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;
        Specified by:
        getRetentionDays in interface NamespaceSpecOrBuilder
        Returns:
        The retentionDays.

      • hasMtlsAuth

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

      • getMtlsAuth

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

      • hasApiKeyAuth

        public 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;
        Specified by:
        hasApiKeyAuth in interface NamespaceSpecOrBuilder
        Returns:
        Whether the apiKeyAuth field is set.

      • getApiKeyAuth

        public 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;
        Specified by:
        getApiKeyAuth in interface NamespaceSpecOrBuilder
        Returns:
        The apiKeyAuth.

      • getApiKeyAuthOrBuilder

        public 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;
        Specified by:
        getApiKeyAuthOrBuilder in interface NamespaceSpecOrBuilder

      • getCustomSearchAttributesCount

        @Deprecated
public int getCustomSearchAttributesCount()
        Deprecated.
        Description copied from interface: NamespaceSpecOrBuilder
         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 2024-10-01-00 api version. Use search_attributes instead.
 temporal:versioning:max_version=2024-10-01-00
        map<string, string> custom_search_attributes = 5 [deprecated = true];
        Specified by:
        getCustomSearchAttributesCount in interface NamespaceSpecOrBuilder

      • containsCustomSearchAttributes

        @Deprecated
public boolean containsCustomSearchAttributes​(java.lang.String key)
        Deprecated.
         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 2024-10-01-00 api version. Use search_attributes instead.
 temporal:versioning:max_version=2024-10-01-00
        map<string, string> custom_search_attributes = 5 [deprecated = true];
        Specified by:
        containsCustomSearchAttributes in interface NamespaceSpecOrBuilder

      • getCustomSearchAttributesMap

        @Deprecated
public java.util.Map<java.lang.String,​java.lang.String> getCustomSearchAttributesMap()
        Deprecated.
         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 2024-10-01-00 api version. Use search_attributes instead.
 temporal:versioning:max_version=2024-10-01-00
        map<string, string> custom_search_attributes = 5 [deprecated = true];
        Specified by:
        getCustomSearchAttributesMap in interface NamespaceSpecOrBuilder

      • getCustomSearchAttributesOrDefault

        @Deprecated
public java.lang.String getCustomSearchAttributesOrDefault​(java.lang.String key,
                                                           java.lang.String defaultValue)
        Deprecated.
         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 2024-10-01-00 api version. Use search_attributes instead.
 temporal:versioning:max_version=2024-10-01-00
        map<string, string> custom_search_attributes = 5 [deprecated = true];
        Specified by:
        getCustomSearchAttributesOrDefault in interface NamespaceSpecOrBuilder

      • getCustomSearchAttributesOrThrow

        @Deprecated
public java.lang.String getCustomSearchAttributesOrThrow​(java.lang.String key)
        Deprecated.
         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 2024-10-01-00 api version. Use search_attributes instead.
 temporal:versioning:max_version=2024-10-01-00
        map<string, string> custom_search_attributes = 5 [deprecated = true];
        Specified by:
        getCustomSearchAttributesOrThrow in interface NamespaceSpecOrBuilder

      • getSearchAttributesCount

        public int getSearchAttributesCount()
        Description copied from interface: NamespaceSpecOrBuilder
         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=2024-10-01-00
 temporal:enums:replaces=custom_search_attributes
        map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;
        Specified by:
        getSearchAttributesCount in interface NamespaceSpecOrBuilder

      • containsSearchAttributes

        public boolean containsSearchAttributes​(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.
 Note: currently deleting a search attribute is not supported.
 Optional, default is empty.
 temporal:versioning:min_version=2024-10-01-00
 temporal:enums:replaces=custom_search_attributes
        map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;
        Specified by:
        containsSearchAttributes in interface NamespaceSpecOrBuilder

      • getSearchAttributesMap

        public java.util.Map<java.lang.String,​NamespaceSpec.SearchAttributeType> getSearchAttributesMap()
         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=2024-10-01-00
 temporal:enums:replaces=custom_search_attributes
        map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;
        Specified by:
        getSearchAttributesMap in interface NamespaceSpecOrBuilder

      • getSearchAttributesOrDefault

        public NamespaceSpec.SearchAttributeType getSearchAttributesOrDefault​(java.lang.String key,
                                                                      NamespaceSpec.SearchAttributeType defaultValue)
         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=2024-10-01-00
 temporal:enums:replaces=custom_search_attributes
        map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;
        Specified by:
        getSearchAttributesOrDefault in interface NamespaceSpecOrBuilder

      • getSearchAttributesOrThrow

        public NamespaceSpec.SearchAttributeType getSearchAttributesOrThrow​(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.
 Note: currently deleting a search attribute is not supported.
 Optional, default is empty.
 temporal:versioning:min_version=2024-10-01-00
 temporal:enums:replaces=custom_search_attributes
        map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;
        Specified by:
        getSearchAttributesOrThrow in interface NamespaceSpecOrBuilder

      • getSearchAttributesValueMap

        public java.util.Map<java.lang.String,​java.lang.Integer> getSearchAttributesValueMap()
         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=2024-10-01-00
 temporal:enums:replaces=custom_search_attributes
        map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;
        Specified by:
        getSearchAttributesValueMap in interface NamespaceSpecOrBuilder

      • getSearchAttributesValueOrDefault

        public int getSearchAttributesValueOrDefault​(java.lang.String key,
                                             int defaultValue)
         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=2024-10-01-00
 temporal:enums:replaces=custom_search_attributes
        map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;
        Specified by:
        getSearchAttributesValueOrDefault in interface NamespaceSpecOrBuilder

      • getSearchAttributesValueOrThrow

        public int getSearchAttributesValueOrThrow​(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.
 Note: currently deleting a search attribute is not supported.
 Optional, default is empty.
 temporal:versioning:min_version=2024-10-01-00
 temporal:enums:replaces=custom_search_attributes
        map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;
        Specified by:
        getSearchAttributesValueOrThrow in interface NamespaceSpecOrBuilder

      • hasCodecServer

        public 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;
        Specified by:
        hasCodecServer in interface NamespaceSpecOrBuilder
        Returns:
        Whether the codecServer field is set.

      • getCodecServer

        public 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;
        Specified by:
        getCodecServer in interface NamespaceSpecOrBuilder
        Returns:
        The codecServer.

      • getCodecServerOrBuilder

        public 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;
        Specified by:
        getCodecServerOrBuilder in interface NamespaceSpecOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static NamespaceSpec parseFrom​(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NamespaceSpec parseFrom​(java.nio.ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NamespaceSpec parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NamespaceSpec parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NamespaceSpec parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NamespaceSpec parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NamespaceSpec parseFrom​(java.io.InputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static NamespaceSpec parseFrom​(java.io.InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static NamespaceSpec parseDelimitedFrom​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static NamespaceSpec parseDelimitedFrom​(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static NamespaceSpec parseFrom​(com.google.protobuf.CodedInputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static NamespaceSpec parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public NamespaceSpec.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public NamespaceSpec.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected NamespaceSpec.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static NamespaceSpec getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<NamespaceSpec> parser()

      • getParserForType

        public com.google.protobuf.Parser<NamespaceSpec> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public NamespaceSpec getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder