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 Details

    • getName

      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

      @Deprecated List<String> getRegionsList()
      Deprecated.
      temporal.api.cloud.namespace.v1.NamespaceSpec.regions is deprecated. See temporal/api/cloud/namespace/v1/message.proto;l=208
       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"].
 Deprecated: Use replicas field instead.
 temporal:versioning:max_version=v0.15.0
      repeated string regions = 2 [deprecated = true];
      Returns:
      A list containing the regions.

    • getRegionsCount

      @Deprecated int getRegionsCount()
      Deprecated.
      temporal.api.cloud.namespace.v1.NamespaceSpec.regions is deprecated. See temporal/api/cloud/namespace/v1/message.proto;l=208
       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"].
 Deprecated: Use replicas field instead.
 temporal:versioning:max_version=v0.15.0
      repeated string regions = 2 [deprecated = true];
      Returns:
      The count of regions.

    • getRegions

      @Deprecated String getRegions(int index)
      Deprecated.
      temporal.api.cloud.namespace.v1.NamespaceSpec.regions is deprecated. See temporal/api/cloud/namespace/v1/message.proto;l=208
       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"].
 Deprecated: Use replicas field instead.
 temporal:versioning:max_version=v0.15.0
      repeated string regions = 2 [deprecated = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The regions at the given index.

    • getRegionsBytes

      @Deprecated com.google.protobuf.ByteString getRegionsBytes(int index)
      Deprecated.
      temporal.api.cloud.namespace.v1.NamespaceSpec.regions is deprecated. See temporal/api/cloud/namespace/v1/message.proto;l=208
       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"].
 Deprecated: Use replicas field instead.
 temporal:versioning:max_version=v0.15.0
      repeated string regions = 2 [deprecated = true];
      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=v0.2.0
      .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=v0.2.0
      .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=v0.2.0
      .temporal.api.cloud.namespace.v1.ApiKeyAuthSpec api_key_auth = 7;

    • getCustomSearchAttributesCount

      @Deprecated int getCustomSearchAttributesCount()
      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 v0.3.0 api version. Use search_attributes instead.
 temporal:versioning:max_version=v0.3.0
      map<string, string> custom_search_attributes = 5 [deprecated = true];

    • containsCustomSearchAttributes

      @Deprecated boolean containsCustomSearchAttributes(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 v0.3.0 api version. Use search_attributes instead.
 temporal:versioning:max_version=v0.3.0
      map<string, string> custom_search_attributes = 5 [deprecated = true];

    • getCustomSearchAttributes

      @Deprecated Map<String,String> getCustomSearchAttributes()
      Deprecated.
      Use getCustomSearchAttributesMap() instead.

    • getCustomSearchAttributesMap

      @Deprecated Map<String,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 v0.3.0 api version. Use search_attributes instead.
 temporal:versioning:max_version=v0.3.0
      map<string, string> custom_search_attributes = 5 [deprecated = true];

    • getCustomSearchAttributesOrDefault

      @Deprecated String getCustomSearchAttributesOrDefault(String key, 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 v0.3.0 api version. Use search_attributes instead.
 temporal:versioning:max_version=v0.3.0
      map<string, string> custom_search_attributes = 5 [deprecated = true];

    • getCustomSearchAttributesOrThrow

      @Deprecated String getCustomSearchAttributesOrThrow(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 v0.3.0 api version. Use search_attributes instead.
 temporal:versioning:max_version=v0.3.0
      map<string, string> custom_search_attributes = 5 [deprecated = true];

    • getSearchAttributesCount

      int getSearchAttributesCount()
       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
      map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;

    • containsSearchAttributes

      boolean containsSearchAttributes(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=v0.3.0
 temporal:enums:replaces=custom_search_attributes
      map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;

    • getSearchAttributes

      @Deprecated Map<String,NamespaceSpec.SearchAttributeType> getSearchAttributes()
      Deprecated.
      Use getSearchAttributesMap() instead.

    • getSearchAttributesMap

      Map<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=v0.3.0
 temporal:enums:replaces=custom_search_attributes
      map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;

    • getSearchAttributesOrDefault

      NamespaceSpec.SearchAttributeType getSearchAttributesOrDefault(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=v0.3.0
 temporal:enums:replaces=custom_search_attributes
      map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;

    • getSearchAttributesOrThrow

      NamespaceSpec.SearchAttributeType getSearchAttributesOrThrow(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=v0.3.0
 temporal:enums:replaces=custom_search_attributes
      map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;

    • getSearchAttributesValue

      @Deprecated Map<String,Integer> getSearchAttributesValue()
      Deprecated.
      Use getSearchAttributesValueMap() instead.

    • getSearchAttributesValueMap

      Map<String,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=v0.3.0
 temporal:enums:replaces=custom_search_attributes
      map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;

    • getSearchAttributesValueOrDefault

      int getSearchAttributesValueOrDefault(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=v0.3.0
 temporal:enums:replaces=custom_search_attributes
      map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;

    • getSearchAttributesValueOrThrow

      int getSearchAttributesValueOrThrow(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=v0.3.0
 temporal:enums:replaces=custom_search_attributes
      map<string, .temporal.api.cloud.namespace.v1.NamespaceSpec.SearchAttributeType> search_attributes = 8;

    • 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;

    • hasLifecycle

      boolean hasLifecycle()
       The lifecycle configuration for the namespace.
 temporal:versioning:min_version=v0.4.0
      .temporal.api.cloud.namespace.v1.LifecycleSpec lifecycle = 9;
      Returns:
      Whether the lifecycle field is set.

    • getLifecycle

      LifecycleSpec getLifecycle()
       The lifecycle configuration for the namespace.
 temporal:versioning:min_version=v0.4.0
      .temporal.api.cloud.namespace.v1.LifecycleSpec lifecycle = 9;
      Returns:
      The lifecycle.

    • getLifecycleOrBuilder

      LifecycleSpecOrBuilder getLifecycleOrBuilder()
       The lifecycle configuration for the namespace.
 temporal:versioning:min_version=v0.4.0
      .temporal.api.cloud.namespace.v1.LifecycleSpec lifecycle = 9;

    • hasHighAvailability

      boolean hasHighAvailability()
       The high availability configuration for the namespace.
 temporal:versioning:min_version=v0.4.0
      .temporal.api.cloud.namespace.v1.HighAvailabilitySpec high_availability = 10;
      Returns:
      Whether the highAvailability field is set.

    • getHighAvailability

      HighAvailabilitySpec getHighAvailability()
       The high availability configuration for the namespace.
 temporal:versioning:min_version=v0.4.0
      .temporal.api.cloud.namespace.v1.HighAvailabilitySpec high_availability = 10;
      Returns:
      The highAvailability.

    • getHighAvailabilityOrBuilder

      HighAvailabilitySpecOrBuilder getHighAvailabilityOrBuilder()
       The high availability configuration for the namespace.
 temporal:versioning:min_version=v0.4.0
      .temporal.api.cloud.namespace.v1.HighAvailabilitySpec high_availability = 10;

    • getConnectivityRuleIdsList

      List<String> getConnectivityRuleIdsList()
       The private connectivity configuration for the namespace.
 This will apply the connectivity rules specified to the namespace.
 temporal:versioning:min_version=v0.6.0
      repeated string connectivity_rule_ids = 11;
      Returns:
      A list containing the connectivityRuleIds.

    • getConnectivityRuleIdsCount

      int getConnectivityRuleIdsCount()
       The private connectivity configuration for the namespace.
 This will apply the connectivity rules specified to the namespace.
 temporal:versioning:min_version=v0.6.0
      repeated string connectivity_rule_ids = 11;
      Returns:
      The count of connectivityRuleIds.

    • getConnectivityRuleIds

      String getConnectivityRuleIds(int index)
       The private connectivity configuration for the namespace.
 This will apply the connectivity rules specified to the namespace.
 temporal:versioning:min_version=v0.6.0
      repeated string connectivity_rule_ids = 11;
      Parameters:
      index - The index of the element to return.
      Returns:
      The connectivityRuleIds at the given index.

    • getConnectivityRuleIdsBytes

      com.google.protobuf.ByteString getConnectivityRuleIdsBytes(int index)
       The private connectivity configuration for the namespace.
 This will apply the connectivity rules specified to the namespace.
 temporal:versioning:min_version=v0.6.0
      repeated string connectivity_rule_ids = 11;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the connectivityRuleIds at the given index.

    • hasCapacitySpec

      boolean hasCapacitySpec()
       The capacity configuration for the namespace.
 There are two capacity modes: on-demand and provisioned.
 On-demand capacity mode allows the namespace to scale automatically based on usage.
 Provisioned capacity mode allows the user to specify a fixed amount of capacity (in TRUs) for the namespace.
 Can be changed only when the last capacity request is not in progress.
 temporal:versioning:min_version=v0.10.0
      .temporal.api.cloud.namespace.v1.CapacitySpec capacity_spec = 12;
      Returns:
      Whether the capacitySpec field is set.

    • getCapacitySpec

      CapacitySpec getCapacitySpec()
       The capacity configuration for the namespace.
 There are two capacity modes: on-demand and provisioned.
 On-demand capacity mode allows the namespace to scale automatically based on usage.
 Provisioned capacity mode allows the user to specify a fixed amount of capacity (in TRUs) for the namespace.
 Can be changed only when the last capacity request is not in progress.
 temporal:versioning:min_version=v0.10.0
      .temporal.api.cloud.namespace.v1.CapacitySpec capacity_spec = 12;
      Returns:
      The capacitySpec.

    • getCapacitySpecOrBuilder

      CapacitySpecOrBuilder getCapacitySpecOrBuilder()
       The capacity configuration for the namespace.
 There are two capacity modes: on-demand and provisioned.
 On-demand capacity mode allows the namespace to scale automatically based on usage.
 Provisioned capacity mode allows the user to specify a fixed amount of capacity (in TRUs) for the namespace.
 Can be changed only when the last capacity request is not in progress.
 temporal:versioning:min_version=v0.10.0
      .temporal.api.cloud.namespace.v1.CapacitySpec capacity_spec = 12;

    • getReplicasList

      List<ReplicaSpec> getReplicasList()
       The replication configuration for the namespace.
 At least one replica must be specified.
 Only one replica can be marked to be the desired active one.
 The status of each replica is available in the Namespace.replicas field.
 Use HighAvailabilitySpec to set the preferred primary replica ID.
 If the preferred primary replica ID is not set, the first replica in this replicas list will be the preferred primary.
 temporal:versioning:min_version=v0.13.0
      repeated .temporal.api.cloud.namespace.v1.ReplicaSpec replicas = 13;

    • getReplicas

      ReplicaSpec getReplicas(int index)
       The replication configuration for the namespace.
 At least one replica must be specified.
 Only one replica can be marked to be the desired active one.
 The status of each replica is available in the Namespace.replicas field.
 Use HighAvailabilitySpec to set the preferred primary replica ID.
 If the preferred primary replica ID is not set, the first replica in this replicas list will be the preferred primary.
 temporal:versioning:min_version=v0.13.0
      repeated .temporal.api.cloud.namespace.v1.ReplicaSpec replicas = 13;

    • getReplicasCount

      int getReplicasCount()
       The replication configuration for the namespace.
 At least one replica must be specified.
 Only one replica can be marked to be the desired active one.
 The status of each replica is available in the Namespace.replicas field.
 Use HighAvailabilitySpec to set the preferred primary replica ID.
 If the preferred primary replica ID is not set, the first replica in this replicas list will be the preferred primary.
 temporal:versioning:min_version=v0.13.0
      repeated .temporal.api.cloud.namespace.v1.ReplicaSpec replicas = 13;

    • getReplicasOrBuilderList

      List<? extends ReplicaSpecOrBuilder> getReplicasOrBuilderList()
       The replication configuration for the namespace.
 At least one replica must be specified.
 Only one replica can be marked to be the desired active one.
 The status of each replica is available in the Namespace.replicas field.
 Use HighAvailabilitySpec to set the preferred primary replica ID.
 If the preferred primary replica ID is not set, the first replica in this replicas list will be the preferred primary.
 temporal:versioning:min_version=v0.13.0
      repeated .temporal.api.cloud.namespace.v1.ReplicaSpec replicas = 13;

    • getReplicasOrBuilder

      ReplicaSpecOrBuilder getReplicasOrBuilder(int index)
       The replication configuration for the namespace.
 At least one replica must be specified.
 Only one replica can be marked to be the desired active one.
 The status of each replica is available in the Namespace.replicas field.
 Use HighAvailabilitySpec to set the preferred primary replica ID.
 If the preferred primary replica ID is not set, the first replica in this replicas list will be the preferred primary.
 temporal:versioning:min_version=v0.13.0
      repeated .temporal.api.cloud.namespace.v1.ReplicaSpec replicas = 13;

    • hasFairness

      boolean hasFairness()
       The fairness configuration for the namespace.
 If unspecified, fairness features will be disabled.
 temporal:versioning:min_version=v0.14.0
      .temporal.api.cloud.namespace.v1.FairnessSpec fairness = 14;
      Returns:
      Whether the fairness field is set.

    • getFairness

      FairnessSpec getFairness()
       The fairness configuration for the namespace.
 If unspecified, fairness features will be disabled.
 temporal:versioning:min_version=v0.14.0
      .temporal.api.cloud.namespace.v1.FairnessSpec fairness = 14;
      Returns:
      The fairness.

    • getFairnessOrBuilder

      FairnessSpecOrBuilder getFairnessOrBuilder()
       The fairness configuration for the namespace.
 If unspecified, fairness features will be disabled.
 temporal:versioning:min_version=v0.14.0
      .temporal.api.cloud.namespace.v1.FairnessSpec fairness = 14;