Package com.azure.resourcemanager.streamanalytics.fluent.models

Class DocumentDbOutputDataSourceProperties

  • public final class DocumentDbOutputDataSourceProperties
extends Object
    The properties that are associated with a DocumentDB output.

    • Constructor Detail

      • DocumentDbOutputDataSourceProperties

        public DocumentDbOutputDataSourceProperties()

    • Method Detail

      • accountId

        public String accountId()
        Get the accountId property: The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests.
        Returns:
        the accountId value.

      • withAccountId

        public DocumentDbOutputDataSourceProperties withAccountId​(String accountId)
        Set the accountId property: The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests.
        Parameters:
        accountId - the accountId value to set.
        Returns:
        the DocumentDbOutputDataSourceProperties object itself.

      • accountKey

        public String accountKey()
        Get the accountKey property: The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests.
        Returns:
        the accountKey value.

      • withAccountKey

        public DocumentDbOutputDataSourceProperties withAccountKey​(String accountKey)
        Set the accountKey property: The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests.
        Parameters:
        accountKey - the accountKey value to set.
        Returns:
        the DocumentDbOutputDataSourceProperties object itself.

      • database

        public String database()
        Get the database property: The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests.
        Returns:
        the database value.

      • withDatabase

        public DocumentDbOutputDataSourceProperties withDatabase​(String database)
        Set the database property: The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests.
        Parameters:
        database - the database value to set.
        Returns:
        the DocumentDbOutputDataSourceProperties object itself.

      • collectionNamePattern

        public String collectionNamePattern()
        Get the collectionNamePattern property: The collection name pattern for the collections to be used. The collection name format can be constructed using the optional {partition} token, where partitions start from 0. See the DocumentDB section of https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests.
        Returns:
        the collectionNamePattern value.

      • withCollectionNamePattern

        public DocumentDbOutputDataSourceProperties withCollectionNamePattern​(String collectionNamePattern)
        Set the collectionNamePattern property: The collection name pattern for the collections to be used. The collection name format can be constructed using the optional {partition} token, where partitions start from 0. See the DocumentDB section of https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests.
        Parameters:
        collectionNamePattern - the collectionNamePattern value to set.
        Returns:
        the DocumentDbOutputDataSourceProperties object itself.

      • partitionKey

        public String partitionKey()
        Get the partitionKey property: The name of the field in output events used to specify the key for partitioning output across collections. If 'collectionNamePattern' contains the {partition} token, this property is required to be specified.
        Returns:
        the partitionKey value.

      • withPartitionKey

        public DocumentDbOutputDataSourceProperties withPartitionKey​(String partitionKey)
        Set the partitionKey property: The name of the field in output events used to specify the key for partitioning output across collections. If 'collectionNamePattern' contains the {partition} token, this property is required to be specified.
        Parameters:
        partitionKey - the partitionKey value to set.
        Returns:
        the DocumentDbOutputDataSourceProperties object itself.

      • documentId

        public String documentId()
        Get the documentId property: The name of the field in output events used to specify the primary key which insert or update operations are based on.
        Returns:
        the documentId value.

      • withDocumentId

        public DocumentDbOutputDataSourceProperties withDocumentId​(String documentId)
        Set the documentId property: The name of the field in output events used to specify the primary key which insert or update operations are based on.
        Parameters:
        documentId - the documentId value to set.
        Returns:
        the DocumentDbOutputDataSourceProperties object itself.

      • validate

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