-
Notifications
You must be signed in to change notification settings - Fork 241
/
com.azure.core.annotation.ServiceClient.yml
51 lines (51 loc) · 3.24 KB
/
com.azure.core.annotation.ServiceClient.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
### YamlMime:JavaType
uid: "com.azure.core.annotation.ServiceClient"
fullName: "com.azure.core.annotation.ServiceClient"
name: "ServiceClient"
nameWithType: "ServiceClient"
summary: "Annotation given to all service client classes."
syntax: "public interface **ServiceClient**</br> implements <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html\">Annotation</a>"
methods:
- uid: "com.azure.core.annotation.ServiceClient.builder()"
fullName: "com.azure.core.annotation.ServiceClient.builder()"
name: "builder()"
nameWithType: "ServiceClient.builder()"
summary: "The builder class that can construct an instance of this class."
modifiers:
- "abstract"
syntax: "public abstract Class<?> builder()"
desc: "The builder class that can construct an instance of this class. All service clients are instantiated using a builder and this is a required field. Also, builders should be annotated with <xref uid=\"com.azure.core.annotation.ServiceClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceClientBuilder\"></xref>."
returns:
description: "the classname of the builder that can create an instance of this class."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html\">Class</a><?>"
- uid: "com.azure.core.annotation.ServiceClient.isAsync()"
fullName: "com.azure.core.annotation.ServiceClient.isAsync()"
name: "isAsync()"
nameWithType: "ServiceClient.isAsync()"
summary: "Represents whether the network IO methods on this client will be performed asynchronously or synchronously (i.<wbr>e."
modifiers:
- "abstract"
syntax: "public abstract boolean isAsync()"
desc: "Represents whether the network IO methods on this client will be performed asynchronously or synchronously (i.e. blocking)."
returns:
description: "<code>true</code> is the Service Client is asynchronous."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.annotation.ServiceClient.serviceInterfaces()"
fullName: "com.azure.core.annotation.ServiceClient.serviceInterfaces()"
name: "serviceInterfaces()"
nameWithType: "ServiceClient.serviceInterfaces()"
summary: "Optional field to indicate all the services this service client interacts with."
modifiers:
- "abstract"
syntax: "public abstract Class<?>[] serviceInterfaces()"
desc: "Optional field to indicate all the services this service client interacts with. All classes mentioned in this list should be annotated with <xref uid=\"com.azure.core.annotation.ServiceInterface\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceInterface\"></xref>. Typically, there's one service associated with each client. However, there could be zero to N services associated with a single client."
returns:
description: "An array of all services this service client interacts with"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html\">Class</a><?>[]"
type: "interface"
desc: "Annotation given to all service client classes."
implements:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html\">Annotation</a>"
metadata: {}
package: "com.azure.core.annotation"
artifact: com.azure:azure-core:1.52.0