Package com.azure.resourcemanager.iothub.models

Class RoutingCosmosDBSqlApiProperties

java.lang.Object
com.azure.resourcemanager.iothub.models.RoutingCosmosDBSqlApiProperties
public final class RoutingCosmosDBSqlApiProperties extends Object
The properties related to a cosmos DB sql collection endpoint.

  • Constructor Details

    • RoutingCosmosDBSqlApiProperties

      public RoutingCosmosDBSqlApiProperties()

  • Method Details

    • name

      public String name()
      Get the name property: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
      Returns:
      the name value.

    • withName

      public RoutingCosmosDBSqlApiProperties withName(String name)
      Set the name property: The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.
      Parameters:
      name - the name value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • id

      public String id()
      Get the id property: Id of the cosmos DB sql collection endpoint.
      Returns:
      the id value.

    • withId

      public RoutingCosmosDBSqlApiProperties withId(String id)
      Set the id property: Id of the cosmos DB sql collection endpoint.
      Parameters:
      id - the id value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • subscriptionId

      public String subscriptionId()
      Get the subscriptionId property: The subscription identifier of the cosmos DB account.
      Returns:
      the subscriptionId value.

    • withSubscriptionId

      public RoutingCosmosDBSqlApiProperties withSubscriptionId(String subscriptionId)
      Set the subscriptionId property: The subscription identifier of the cosmos DB account.
      Parameters:
      subscriptionId - the subscriptionId value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • resourceGroup

      public String resourceGroup()
      Get the resourceGroup property: The name of the resource group of the cosmos DB account.
      Returns:
      the resourceGroup value.

    • withResourceGroup

      public RoutingCosmosDBSqlApiProperties withResourceGroup(String resourceGroup)
      Set the resourceGroup property: The name of the resource group of the cosmos DB account.
      Parameters:
      resourceGroup - the resourceGroup value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • endpointUri

      public String endpointUri()
      Get the endpointUri property: The url of the cosmos DB account. It must include the protocol https://.
      Returns:
      the endpointUri value.

    • withEndpointUri

      public RoutingCosmosDBSqlApiProperties withEndpointUri(String endpointUri)
      Set the endpointUri property: The url of the cosmos DB account. It must include the protocol https://.
      Parameters:
      endpointUri - the endpointUri value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • authenticationType

      public AuthenticationType authenticationType()
      Get the authenticationType property: Method used to authenticate against the cosmos DB sql collection endpoint.
      Returns:
      the authenticationType value.

    • withAuthenticationType

      public RoutingCosmosDBSqlApiProperties withAuthenticationType(AuthenticationType authenticationType)
      Set the authenticationType property: Method used to authenticate against the cosmos DB sql collection endpoint.
      Parameters:
      authenticationType - the authenticationType value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • identity

      public ManagedIdentity identity()
      Get the identity property: Managed identity properties of routing cosmos DB collection endpoint.
      Returns:
      the identity value.

    • withIdentity

      public RoutingCosmosDBSqlApiProperties withIdentity(ManagedIdentity identity)
      Set the identity property: Managed identity properties of routing cosmos DB collection endpoint.
      Parameters:
      identity - the identity value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • primaryKey

      public String primaryKey()
      Get the primaryKey property: The primary key of the cosmos DB account.
      Returns:
      the primaryKey value.

    • withPrimaryKey

      public RoutingCosmosDBSqlApiProperties withPrimaryKey(String primaryKey)
      Set the primaryKey property: The primary key of the cosmos DB account.
      Parameters:
      primaryKey - the primaryKey value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • secondaryKey

      public String secondaryKey()
      Get the secondaryKey property: The secondary key of the cosmos DB account.
      Returns:
      the secondaryKey value.

    • withSecondaryKey

      public RoutingCosmosDBSqlApiProperties withSecondaryKey(String secondaryKey)
      Set the secondaryKey property: The secondary key of the cosmos DB account.
      Parameters:
      secondaryKey - the secondaryKey value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • databaseName

      public String databaseName()
      Get the databaseName property: The name of the cosmos DB database in the cosmos DB account.
      Returns:
      the databaseName value.

    • withDatabaseName

      public RoutingCosmosDBSqlApiProperties withDatabaseName(String databaseName)
      Set the databaseName property: The name of the cosmos DB database in the cosmos DB account.
      Parameters:
      databaseName - the databaseName value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • collectionName

      public String collectionName()
      Get the collectionName property: The name of the cosmos DB sql collection in the cosmos DB database.
      Returns:
      the collectionName value.

    • withCollectionName

      public RoutingCosmosDBSqlApiProperties withCollectionName(String collectionName)
      Set the collectionName property: The name of the cosmos DB sql collection in the cosmos DB database.
      Parameters:
      collectionName - the collectionName value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • partitionKeyName

      public String partitionKeyName()
      Get the partitionKeyName property: The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.
      Returns:
      the partitionKeyName value.

    • withPartitionKeyName

      public RoutingCosmosDBSqlApiProperties withPartitionKeyName(String partitionKeyName)
      Set the partitionKeyName property: The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.
      Parameters:
      partitionKeyName - the partitionKeyName value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • partitionKeyTemplate

      public String partitionKeyTemplate()
      Get the partitionKeyTemplate property: The template for generating a synthetic partition key value for use with this cosmos DB sql collection. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.
      Returns:
      the partitionKeyTemplate value.

    • withPartitionKeyTemplate

      public RoutingCosmosDBSqlApiProperties withPartitionKeyTemplate(String partitionKeyTemplate)
      Set the partitionKeyTemplate property: The template for generating a synthetic partition key value for use with this cosmos DB sql collection. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.
      Parameters:
      partitionKeyTemplate - the partitionKeyTemplate value to set.
      Returns:
      the RoutingCosmosDBSqlApiProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.