-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.microsoft.azure.batch.BatchClient.yml
188 lines (188 loc) · 18.6 KB
/
com.microsoft.azure.batch.BatchClient.yml
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
### YamlMime:JavaType
uid: "com.microsoft.azure.batch.BatchClient"
fullName: "com.microsoft.azure.batch.BatchClient"
name: "BatchClient"
nameWithType: "BatchClient"
summary: "A client for an Azure Batch account, used to access the Batch service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **BatchClient**"
methods:
- uid: "com.microsoft.azure.batch.BatchClient.accountOperations()"
fullName: "com.microsoft.azure.batch.BatchClient.accountOperations()"
name: "accountOperations()"
nameWithType: "BatchClient.accountOperations()"
summary: "Gets an <xref uid=\"com.microsoft.azure.batch.AccountOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountOperations\"></xref> object for performing account-related operations on the associated account."
syntax: "public AccountOperations accountOperations()"
desc: "Gets an <xref uid=\"com.microsoft.azure.batch.AccountOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountOperations\"></xref> object for performing account-related operations on the associated account."
returns:
description: "An instance of the <xref uid=\"com.microsoft.azure.batch.AccountOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountOperations\"></xref> class."
type: "<xref href=\"com.microsoft.azure.batch.AccountOperations?alt=com.microsoft.azure.batch.AccountOperations&text=AccountOperations\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.applicationOperations()"
fullName: "com.microsoft.azure.batch.BatchClient.applicationOperations()"
name: "applicationOperations()"
nameWithType: "BatchClient.applicationOperations()"
summary: "Gets an <xref uid=\"com.microsoft.azure.batch.ApplicationOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ApplicationOperations\"></xref> object for performing application-related operations on the associated account."
syntax: "public ApplicationOperations applicationOperations()"
desc: "Gets an <xref uid=\"com.microsoft.azure.batch.ApplicationOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ApplicationOperations\"></xref> object for performing application-related operations on the associated account."
returns:
description: "An instance of the <xref uid=\"com.microsoft.azure.batch.ApplicationOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ApplicationOperations\"></xref> class."
type: "<xref href=\"com.microsoft.azure.batch.ApplicationOperations?alt=com.microsoft.azure.batch.ApplicationOperations&text=ApplicationOperations\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.certificateOperations()"
fullName: "com.microsoft.azure.batch.BatchClient.certificateOperations()"
name: "certificateOperations()"
nameWithType: "BatchClient.certificateOperations()"
summary: "Gets a <xref uid=\"com.microsoft.azure.batch.CertificateOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CertificateOperations\"></xref> object for performing certificate-related operations on the associated account."
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public CertificateOperations certificateOperations()"
desc: "Gets a <xref uid=\"com.microsoft.azure.batch.CertificateOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CertificateOperations\"></xref> object for performing certificate-related operations on the associated account. Warning: This operation is deprecated and will be removed after February, 2024. Please use the \\[Azure KeyVault Extension\\](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead."
returns:
description: "An instance of the <xref uid=\"com.microsoft.azure.batch.CertificateOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CertificateOperations\"></xref> class."
type: "<xref href=\"com.microsoft.azure.batch.CertificateOperations?alt=com.microsoft.azure.batch.CertificateOperations&text=CertificateOperations\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.computeNodeOperations()"
fullName: "com.microsoft.azure.batch.BatchClient.computeNodeOperations()"
name: "computeNodeOperations()"
nameWithType: "BatchClient.computeNodeOperations()"
summary: "Gets a <xref uid=\"com.microsoft.azure.batch.ComputeNodeOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputeNodeOperations\"></xref> object for performing compute node-related operations on the associated account."
syntax: "public ComputeNodeOperations computeNodeOperations()"
desc: "Gets a <xref uid=\"com.microsoft.azure.batch.ComputeNodeOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputeNodeOperations\"></xref> object for performing compute node-related operations on the associated account."
returns:
description: "An instance of the <xref uid=\"com.microsoft.azure.batch.ComputeNodeOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ComputeNodeOperations\"></xref> class."
type: "<xref href=\"com.microsoft.azure.batch.ComputeNodeOperations?alt=com.microsoft.azure.batch.ComputeNodeOperations&text=ComputeNodeOperations\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.customBehaviors()"
fullName: "com.microsoft.azure.batch.BatchClient.customBehaviors()"
name: "customBehaviors()"
nameWithType: "BatchClient.customBehaviors()"
summary: "Gets a collection of behaviors that modify or customize requests to the Batch service."
syntax: "public Collection<BatchClientBehavior> customBehaviors()"
desc: "Gets a collection of behaviors that modify or customize requests to the Batch service."
returns:
description: "The collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.BatchClient.fileOperations()"
fullName: "com.microsoft.azure.batch.BatchClient.fileOperations()"
name: "fileOperations()"
nameWithType: "BatchClient.fileOperations()"
summary: "Gets a <xref uid=\"com.microsoft.azure.batch.FileOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileOperations\"></xref> object for performing file-related operations on the associated account."
syntax: "public FileOperations fileOperations()"
desc: "Gets a <xref uid=\"com.microsoft.azure.batch.FileOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileOperations\"></xref> object for performing file-related operations on the associated account."
returns:
description: "An instance of the <xref uid=\"com.microsoft.azure.batch.FileOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileOperations\"></xref> class."
type: "<xref href=\"com.microsoft.azure.batch.FileOperations?alt=com.microsoft.azure.batch.FileOperations&text=FileOperations\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.jobOperations()"
fullName: "com.microsoft.azure.batch.BatchClient.jobOperations()"
name: "jobOperations()"
nameWithType: "BatchClient.jobOperations()"
summary: "Gets a <xref uid=\"com.microsoft.azure.batch.JobOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JobOperations\"></xref> object for performing job-related operations on the associated account."
syntax: "public JobOperations jobOperations()"
desc: "Gets a <xref uid=\"com.microsoft.azure.batch.JobOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JobOperations\"></xref> object for performing job-related operations on the associated account."
returns:
description: "An instance of the <xref uid=\"com.microsoft.azure.batch.JobOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JobOperations\"></xref> class."
type: "<xref href=\"com.microsoft.azure.batch.JobOperations?alt=com.microsoft.azure.batch.JobOperations&text=JobOperations\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.jobScheduleOperations()"
fullName: "com.microsoft.azure.batch.BatchClient.jobScheduleOperations()"
name: "jobScheduleOperations()"
nameWithType: "BatchClient.jobScheduleOperations()"
summary: "Gets a <xref uid=\"com.microsoft.azure.batch.JobScheduleOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JobScheduleOperations\"></xref> object for performing job schedule-related operations on the associated account."
syntax: "public JobScheduleOperations jobScheduleOperations()"
desc: "Gets a <xref uid=\"com.microsoft.azure.batch.JobScheduleOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JobScheduleOperations\"></xref> object for performing job schedule-related operations on the associated account."
returns:
description: "An instance of the <xref uid=\"com.microsoft.azure.batch.JobScheduleOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JobScheduleOperations\"></xref> class."
type: "<xref href=\"com.microsoft.azure.batch.JobScheduleOperations?alt=com.microsoft.azure.batch.JobScheduleOperations&text=JobScheduleOperations\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.open(com.microsoft.azure.batch.auth.BatchCredentials)"
fullName: "com.microsoft.azure.batch.BatchClient.open(BatchCredentials credentials)"
name: "open(BatchCredentials credentials)"
nameWithType: "BatchClient.open(BatchCredentials credentials)"
summary: "Creates an instance of <xref uid=\"com.microsoft.azure.batch.BatchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClient\"></xref> associated with the specified credentials."
modifiers:
- "static"
parameters:
- description: "A <xref uid=\"com.microsoft.azure.batch.auth.BatchCredentials\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchCredentials\"></xref> object specifying the Batch account credentials."
name: "credentials"
type: "<xref href=\"com.microsoft.azure.batch.auth.BatchCredentials?alt=com.microsoft.azure.batch.auth.BatchCredentials&text=BatchCredentials\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static BatchClient open(BatchCredentials credentials)"
desc: "Creates an instance of <xref uid=\"com.microsoft.azure.batch.BatchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClient\"></xref> associated with the specified credentials."
returns:
description: "The new <xref uid=\"com.microsoft.azure.batch.BatchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClient\"></xref> instance."
type: "<xref href=\"com.microsoft.azure.batch.BatchClient?alt=com.microsoft.azure.batch.BatchClient&text=BatchClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.open(com.microsoft.rest.RestClient,java.lang.String)"
fullName: "com.microsoft.azure.batch.BatchClient.open(RestClient restClient, String baseUrl)"
name: "open(RestClient restClient, String baseUrl)"
nameWithType: "BatchClient.open(RestClient restClient, String baseUrl)"
summary: "Creates an instance of <xref uid=\"com.microsoft.azure.batch.BatchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClient\"></xref> associated with the specified rest<wbr>Client and baseurl."
modifiers:
- "static"
parameters:
- description: "A <xref uid=\"com.microsoft.rest.RestClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RestClient\"></xref> object specifying the definition of rest client used to\n interact with batch endpoint."
name: "restClient"
type: "<xref href=\"com.microsoft.rest.RestClient?alt=com.microsoft.rest.RestClient&text=RestClient\" data-throw-if-not-resolved=\"False\" />"
- description: "A String object specifying the the batch end point."
name: "baseUrl"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static BatchClient open(RestClient restClient, String baseUrl)"
desc: "Creates an instance of <xref uid=\"com.microsoft.azure.batch.BatchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClient\"></xref> associated with the specified restClient and baseurl."
returns:
description: "The new <xref uid=\"com.microsoft.azure.batch.BatchClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClient\"></xref> instance."
type: "<xref href=\"com.microsoft.azure.batch.BatchClient?alt=com.microsoft.azure.batch.BatchClient&text=BatchClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.poolOperations()"
fullName: "com.microsoft.azure.batch.BatchClient.poolOperations()"
name: "poolOperations()"
nameWithType: "BatchClient.poolOperations()"
summary: "Gets a <xref uid=\"com.microsoft.azure.batch.PoolOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PoolOperations\"></xref> object for performing pool-related operations on the associated account."
syntax: "public PoolOperations poolOperations()"
desc: "Gets a <xref uid=\"com.microsoft.azure.batch.PoolOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PoolOperations\"></xref> object for performing pool-related operations on the associated account."
returns:
description: "An instance of the <xref uid=\"com.microsoft.azure.batch.PoolOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PoolOperations\"></xref> class."
type: "<xref href=\"com.microsoft.azure.batch.PoolOperations?alt=com.microsoft.azure.batch.PoolOperations&text=PoolOperations\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.protocolLayer()"
fullName: "com.microsoft.azure.batch.BatchClient.protocolLayer()"
name: "protocolLayer()"
nameWithType: "BatchClient.protocolLayer()"
summary: "Gets the protocol layer service client that issues requests to the Azure Batch service."
syntax: "public BatchServiceClient protocolLayer()"
desc: "Gets the protocol layer service client that issues requests to the Azure Batch service."
returns:
description: "The protocol layer client."
type: "<xref href=\"com.microsoft.azure.batch.protocol.BatchServiceClient?alt=com.microsoft.azure.batch.protocol.BatchServiceClient&text=BatchServiceClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.taskOperations()"
fullName: "com.microsoft.azure.batch.BatchClient.taskOperations()"
name: "taskOperations()"
nameWithType: "BatchClient.taskOperations()"
summary: "Gets a <xref uid=\"com.microsoft.azure.batch.TaskOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TaskOperations\"></xref> object for performing task-related operations on the associated account."
syntax: "public TaskOperations taskOperations()"
desc: "Gets a <xref uid=\"com.microsoft.azure.batch.TaskOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TaskOperations\"></xref> object for performing task-related operations on the associated account."
returns:
description: "An instance of the <xref uid=\"com.microsoft.azure.batch.TaskOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TaskOperations\"></xref> class."
type: "<xref href=\"com.microsoft.azure.batch.TaskOperations?alt=com.microsoft.azure.batch.TaskOperations&text=TaskOperations\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.BatchClient.withCustomBehaviors(java.util.Collection<com.microsoft.azure.batch.BatchClientBehavior>)"
fullName: "com.microsoft.azure.batch.BatchClient.withCustomBehaviors(Collection<BatchClientBehavior> customBehaviors)"
name: "withCustomBehaviors(Collection<BatchClientBehavior> customBehaviors)"
nameWithType: "BatchClient.withCustomBehaviors(Collection<BatchClientBehavior> customBehaviors)"
summary: "Sets a collection of behaviors that modify or customize requests to the Batch service."
parameters:
- description: "The collection of <xref uid=\"com.microsoft.azure.batch.BatchClientBehavior\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BatchClientBehavior\"></xref> instances."
name: "customBehaviors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.microsoft.azure.batch.BatchClientBehavior?alt=com.microsoft.azure.batch.BatchClientBehavior&text=BatchClientBehavior\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public BatchClient withCustomBehaviors(Collection<BatchClientBehavior> customBehaviors)"
desc: "Sets a collection of behaviors that modify or customize requests to the Batch service."
returns:
description: "The current instance."
type: "<xref href=\"com.microsoft.azure.batch.BatchClient?alt=com.microsoft.azure.batch.BatchClient&text=BatchClient\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A client for an Azure Batch account, used to access the Batch service."
metadata: {}
package: "com.microsoft.azure.batch"
artifact: com.microsoft.azure:azure-batch:11.1.1