Class: Azure::ARM::StreamAnalytics::Models::DocumentDbOutputDataSource

Inherits:
OutputDataSource
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_stream_analytics/models/document_db_output_data_source.rb

Overview

Describes a DocumentDB output data source.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DocumentDbOutputDataSource

Returns a new instance of DocumentDbOutputDataSource.



17
18
19
 
# File 'lib/generated/azure_mgmt_stream_analytics/models/document_db_output_data_source.rb', line 17

def initialize
  @type = "Microsoft.Storage/DocumentDB"
end

Instance Attribute Details

#account_id ⇒ String

(CreateOrReplace) requests.

Returns:

  • (String) —

    The DocumentDB account name or ID. Required on PUT



25
26
27
 
# File 'lib/generated/azure_mgmt_stream_analytics/models/document_db_output_data_source.rb', line 25

def 
  @account_id
end

#account_key ⇒ String

on PUT (CreateOrReplace) requests.

Returns:

  • (String) —

    The account key for the DocumentDB account. Required



29
30
31
 
# File 'lib/generated/azure_mgmt_stream_analytics/models/document_db_output_data_source.rb', line 29

def 
  @account_key
end

#collection_name_pattern ⇒ String

used. The collection name format can be constructed using the optional partition token, where partitions start from 0. See the DocumentDB section of docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests.

Returns:

  • (String) —

    The collection name pattern for the collections to be



41
42
43
 
# File 'lib/generated/azure_mgmt_stream_analytics/models/document_db_output_data_source.rb', line 41

def collection_name_pattern
  @collection_name_pattern
end

#database ⇒ String

(CreateOrReplace) requests.

Returns:

  • (String) —

    The name of the DocumentDB database. Required on PUT



33
34
35
 
# File 'lib/generated/azure_mgmt_stream_analytics/models/document_db_output_data_source.rb', line 33

def database
  @database
end

#document_id ⇒ String

the primary key which insert or update operations are based on.

Returns:

  • (String) —

    The name of the field in output events used to specify



51
52
53
 
# File 'lib/generated/azure_mgmt_stream_analytics/models/document_db_output_data_source.rb', line 51

def document_id
  @document_id
end

#partition_key ⇒ String

the key for partitioning output across collections. If ‘collectionNamePattern’ contains the partition token, this property is required to be specified.

Returns:

  • (String) —

    The name of the field in output events used to specify



47
48
49
 
# File 'lib/generated/azure_mgmt_stream_analytics/models/document_db_output_data_source.rb', line 47

def partition_key
  @partition_key
end

#type ⇒ Object

Returns the value of attribute type.



21
22
23
 
# File 'lib/generated/azure_mgmt_stream_analytics/models/document_db_output_data_source.rb', line 21

def type
  @type
end

Class Method Details

.mapper ⇒ Object

Mapper for DocumentDbOutputDataSource class as Ruby Hash. This will be used for serialization/deserialization.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/generated/azure_mgmt_stream_analytics/models/document_db_output_data_source.rb', line 58

def self.mapper()
  {
    required: false,
    serialized_name: 'Microsoft.Storage/DocumentDB',
    type: {
      name: 'Composite',
      class_name: 'DocumentDbOutputDataSource',
      model_properties: {
        type: {
          required: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        account_id: {
          required: false,
          serialized_name: 'properties.accountId',
          type: {
            name: 'String'
          }
        },
        account_key: {
          required: false,
          serialized_name: 'properties.accountKey',
          type: {
            name: 'String'
          }
        },
        database: {
          required: false,
          serialized_name: 'properties.database',
          type: {
            name: 'String'
          }
        },
        collection_name_pattern: {
          required: false,
          serialized_name: 'properties.collectionNamePattern',
          type: {
            name: 'String'
          }
        },
        partition_key: {
          required: false,
          serialized_name: 'properties.partitionKey',
          type: {
            name: 'String'
          }
        },
        document_id: {
          required: false,
          serialized_name: 'properties.documentId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end