Package com.azure.resourcemanager.iothub.models

Class RoutingStorageContainerProperties

java.lang.Object
com.azure.resourcemanager.iothub.models.RoutingStorageContainerProperties
public final class RoutingStorageContainerProperties extends Object
The properties related to a storage container endpoint.

  • Constructor Details

    • RoutingStorageContainerProperties

      public RoutingStorageContainerProperties()

  • Method Details

    • id

      public String id()
      Get the id property: Id of the storage container endpoint.
      Returns:
      the id value.

    • withId

      public RoutingStorageContainerProperties withId(String id)
      Set the id property: Id of the storage container endpoint.
      Parameters:
      id - the id value to set.
      Returns:
      the RoutingStorageContainerProperties object itself.

    • connectionString

      public String connectionString()
      Get the connectionString property: The connection string of the storage account.
      Returns:
      the connectionString value.

    • withConnectionString

      public RoutingStorageContainerProperties withConnectionString(String connectionString)
      Set the connectionString property: The connection string of the storage account.
      Parameters:
      connectionString - the connectionString value to set.
      Returns:
      the RoutingStorageContainerProperties object itself.

    • endpointUri

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

    • withEndpointUri

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

    • authenticationType

      public AuthenticationType authenticationType()
      Get the authenticationType property: Method used to authenticate against the storage endpoint.
      Returns:
      the authenticationType value.

    • withAuthenticationType

      public RoutingStorageContainerProperties withAuthenticationType(AuthenticationType authenticationType)
      Set the authenticationType property: Method used to authenticate against the storage endpoint.
      Parameters:
      authenticationType - the authenticationType value to set.
      Returns:
      the RoutingStorageContainerProperties object itself.

    • identity

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

    • withIdentity

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

    • 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 RoutingStorageContainerProperties 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 RoutingStorageContainerProperties object itself.

    • subscriptionId

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

    • withSubscriptionId

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

    • resourceGroup

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

    • withResourceGroup

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

    • containerName

      public String containerName()
      Get the containerName property: The name of storage container in the storage account.
      Returns:
      the containerName value.

    • withContainerName

      public RoutingStorageContainerProperties withContainerName(String containerName)
      Set the containerName property: The name of storage container in the storage account.
      Parameters:
      containerName - the containerName value to set.
      Returns:
      the RoutingStorageContainerProperties object itself.

    • fileNameFormat

      public String fileNameFormat()
      Get the fileNameFormat property: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
      Returns:
      the fileNameFormat value.

    • withFileNameFormat

      public RoutingStorageContainerProperties withFileNameFormat(String fileNameFormat)
      Set the fileNameFormat property: File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.
      Parameters:
      fileNameFormat - the fileNameFormat value to set.
      Returns:
      the RoutingStorageContainerProperties object itself.

    • batchFrequencyInSeconds

      public Integer batchFrequencyInSeconds()
      Get the batchFrequencyInSeconds property: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
      Returns:
      the batchFrequencyInSeconds value.

    • withBatchFrequencyInSeconds

      public RoutingStorageContainerProperties withBatchFrequencyInSeconds(Integer batchFrequencyInSeconds)
      Set the batchFrequencyInSeconds property: Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.
      Parameters:
      batchFrequencyInSeconds - the batchFrequencyInSeconds value to set.
      Returns:
      the RoutingStorageContainerProperties object itself.

    • maxChunkSizeInBytes

      public Integer maxChunkSizeInBytes()
      Get the maxChunkSizeInBytes property: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
      Returns:
      the maxChunkSizeInBytes value.

    • withMaxChunkSizeInBytes

      public RoutingStorageContainerProperties withMaxChunkSizeInBytes(Integer maxChunkSizeInBytes)
      Set the maxChunkSizeInBytes property: Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).
      Parameters:
      maxChunkSizeInBytes - the maxChunkSizeInBytes value to set.
      Returns:
      the RoutingStorageContainerProperties object itself.

    • encoding

      public RoutingStorageContainerPropertiesEncoding encoding()
      Get the encoding property: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.
      Returns:
      the encoding value.

    • withEncoding

      public RoutingStorageContainerProperties withEncoding(RoutingStorageContainerPropertiesEncoding encoding)
      Set the encoding property: Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.
      Parameters:
      encoding - the encoding value to set.
      Returns:
      the RoutingStorageContainerProperties object itself.

    • validate

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