-
Notifications
You must be signed in to change notification settings - Fork 256
/
NotebookSessionProperties.xml
157 lines (157 loc) · 9.4 KB
/
NotebookSessionProperties.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<Type Name="NotebookSessionProperties" FullName="Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties">
<TypeSignature Language="C#" Value="public class NotebookSessionProperties" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NotebookSessionProperties extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties" />
<TypeSignature Language="VB.NET" Value="Public Class NotebookSessionProperties" />
<TypeSignature Language="F#" Value="type NotebookSessionProperties = class" />
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties+NotebookSessionPropertiesConverter))]</AttributeName>
<AttributeName Language="F#">[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties+NotebookSessionPropertiesConverter))>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary> Session properties. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NotebookSessionProperties (string driverMemory, int driverCores, string executorMemory, int executorCores, int numExecutors);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string driverMemory, int32 driverCores, string executorMemory, int32 executorCores, int32 numExecutors) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.#ctor(System.String,System.Int32,System.String,System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (driverMemory As String, driverCores As Integer, executorMemory As String, executorCores As Integer, numExecutors As Integer)" />
<MemberSignature Language="F#" Value="new Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties : string * int * string * int * int -> Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties" Usage="new Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties (driverMemory, driverCores, executorMemory, executorCores, numExecutors)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="driverMemory" Type="System.String" />
<Parameter Name="driverCores" Type="System.Int32" />
<Parameter Name="executorMemory" Type="System.String" />
<Parameter Name="executorCores" Type="System.Int32" />
<Parameter Name="numExecutors" Type="System.Int32" />
</Parameters>
<Docs>
<param name="driverMemory"> Amount of memory to use for the driver process. </param>
<param name="driverCores"> Number of cores to use for the driver. </param>
<param name="executorMemory"> Amount of memory to use per executor process. </param>
<param name="executorCores"> Number of cores to use for each executor. </param>
<param name="numExecutors"> Number of executors to launch for this session. </param>
<summary> Initializes a new instance of <see cref="T:Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties" />. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="driverMemory" /> or <paramref name="executorMemory" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="DriverCores">
<MemberSignature Language="C#" Value="public int DriverCores { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 DriverCores" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.DriverCores" />
<MemberSignature Language="VB.NET" Value="Public Property DriverCores As Integer" />
<MemberSignature Language="F#" Value="member this.DriverCores : int with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.DriverCores" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary> Number of cores to use for the driver. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DriverMemory">
<MemberSignature Language="C#" Value="public string DriverMemory { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DriverMemory" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.DriverMemory" />
<MemberSignature Language="VB.NET" Value="Public Property DriverMemory As String" />
<MemberSignature Language="F#" Value="member this.DriverMemory : string with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.DriverMemory" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> Amount of memory to use for the driver process. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExecutorCores">
<MemberSignature Language="C#" Value="public int ExecutorCores { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 ExecutorCores" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.ExecutorCores" />
<MemberSignature Language="VB.NET" Value="Public Property ExecutorCores As Integer" />
<MemberSignature Language="F#" Value="member this.ExecutorCores : int with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.ExecutorCores" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary> Number of cores to use for each executor. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExecutorMemory">
<MemberSignature Language="C#" Value="public string ExecutorMemory { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ExecutorMemory" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.ExecutorMemory" />
<MemberSignature Language="VB.NET" Value="Public Property ExecutorMemory As String" />
<MemberSignature Language="F#" Value="member this.ExecutorMemory : string with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.ExecutorMemory" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> Amount of memory to use per executor process. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NumExecutors">
<MemberSignature Language="C#" Value="public int NumExecutors { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 NumExecutors" />
<MemberSignature Language="DocId" Value="P:Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.NumExecutors" />
<MemberSignature Language="VB.NET" Value="Public Property NumExecutors As Integer" />
<MemberSignature Language="F#" Value="member this.NumExecutors : int with get, set" Usage="Azure.Analytics.Synapse.Artifacts.Models.NotebookSessionProperties.NumExecutors" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Synapse.Artifacts</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary> Number of executors to launch for this session. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>