Class DocumentDbOutputDataSource
- java.lang.Object
-
- com.azure.resourcemanager.streamanalytics.models.OutputDataSource
-
- com.azure.resourcemanager.streamanalytics.models.DocumentDbOutputDataSource
-
public final class DocumentDbOutputDataSource extends OutputDataSource
Describes a DocumentDB output data source.
-
-
Constructor Summary
Constructors Constructor Description DocumentDbOutputDataSource()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
accountId()
Get the accountId property: The DocumentDB account name or ID.String
accountKey()
Get the accountKey property: The account key for the DocumentDB account.String
collectionNamePattern()
Get the collectionNamePattern property: The collection name pattern for the collections to be used.String
database()
Get the database property: The name of the DocumentDB database.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.String
partitionKey()
Get the partitionKey property: The name of the field in output events used to specify the key for partitioning output across collections.void
validate()
Validates the instance.DocumentDbOutputDataSource
withAccountId(String accountId)
Set the accountId property: The DocumentDB account name or ID.DocumentDbOutputDataSource
withAccountKey(String accountKey)
Set the accountKey property: The account key for the DocumentDB account.DocumentDbOutputDataSource
withCollectionNamePattern(String collectionNamePattern)
Set the collectionNamePattern property: The collection name pattern for the collections to be used.DocumentDbOutputDataSource
withDatabase(String database)
Set the database property: The name of the DocumentDB database.DocumentDbOutputDataSource
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.DocumentDbOutputDataSource
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.
-
-
-
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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource 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 DocumentDbOutputDataSource object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classOutputDataSource
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-