/
com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.yml
156 lines (156 loc) · 11.6 KB
/
com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.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
### YamlMime:JavaType
uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner"
name: "GroupContractInner"
nameWithType: "GroupContractInner"
summary: "Contract details."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.core.management.ProxyResource?alt=com.azure.core.management.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.core.management.ProxyResource.id()?alt=com.azure.core.management.ProxyResource.id&text=id\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource.name()?alt=com.azure.core.management.ProxyResource.name&text=name\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.management.ProxyResource.type()?alt=com.azure.core.management.ProxyResource.type&text=type\" data-throw-if-not-resolved=\"False\" />"
- 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 final class **GroupContractInner**</br> extends <xref href=\"com.azure.core.management.ProxyResource?alt=com.azure.core.management.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.GroupContractInner()"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.GroupContractInner()"
name: "GroupContractInner()"
nameWithType: "GroupContractInner.GroupContractInner()"
summary: "Creates an instance of Group<wbr>Contract<wbr>Inner class."
syntax: "public GroupContractInner()"
desc: "Creates an instance of GroupContractInner class."
methods:
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.builtIn()"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.builtIn()"
name: "builtIn()"
nameWithType: "GroupContractInner.builtIn()"
summary: "Get the built<wbr>In property: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false."
syntax: "public Boolean builtIn()"
desc: "Get the builtIn property: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false."
returns:
description: "the builtIn value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.description()"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.description()"
name: "description()"
nameWithType: "GroupContractInner.description()"
summary: "Get the description property: Group description."
syntax: "public String description()"
desc: "Get the description property: Group description. Can contain HTML formatting tags."
returns:
description: "the description value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.displayName()"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.displayName()"
name: "displayName()"
nameWithType: "GroupContractInner.displayName()"
summary: "Get the display<wbr>Name property: Group name."
syntax: "public String displayName()"
desc: "Get the displayName property: Group name."
returns:
description: "the displayName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.externalId()"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.externalId()"
name: "externalId()"
nameWithType: "GroupContractInner.externalId()"
summary: "Get the external<wbr>Id property: For external groups, this property contains the id of the group from the external identity provider, e.<wbr>g."
syntax: "public String externalId()"
desc: "Get the externalId property: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory \\`aad://<tenant>.onmicrosoft.com/groups/<group object id>\\`; otherwise the value is null."
returns:
description: "the externalId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.typePropertiesType()"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.typePropertiesType()"
name: "typePropertiesType()"
nameWithType: "GroupContractInner.typePropertiesType()"
summary: "Get the type property: Group type."
syntax: "public GroupType typePropertiesType()"
desc: "Get the type property: Group type."
returns:
description: "the type value."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.GroupType?alt=com.azure.resourcemanager.apimanagement.models.GroupType&text=GroupType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.validate()"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.validate()"
name: "validate()"
nameWithType: "GroupContractInner.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.withDescription(java.lang.String)"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.withDescription(String description)"
name: "withDescription(String description)"
nameWithType: "GroupContractInner.withDescription(String description)"
summary: "Set the description property: Group description."
parameters:
- description: "the description value to set."
name: "description"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public GroupContractInner withDescription(String description)"
desc: "Set the description property: Group description. Can contain HTML formatting tags."
returns:
description: "the GroupContractInner object itself."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner?alt=com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner&text=GroupContractInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.withDisplayName(java.lang.String)"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.withDisplayName(String displayName)"
name: "withDisplayName(String displayName)"
nameWithType: "GroupContractInner.withDisplayName(String displayName)"
summary: "Set the display<wbr>Name property: Group name."
parameters:
- description: "the displayName value to set."
name: "displayName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public GroupContractInner withDisplayName(String displayName)"
desc: "Set the displayName property: Group name."
returns:
description: "the GroupContractInner object itself."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner?alt=com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner&text=GroupContractInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.withExternalId(java.lang.String)"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.withExternalId(String externalId)"
name: "withExternalId(String externalId)"
nameWithType: "GroupContractInner.withExternalId(String externalId)"
summary: "Set the external<wbr>Id property: For external groups, this property contains the id of the group from the external identity provider, e.<wbr>g."
parameters:
- description: "the externalId value to set."
name: "externalId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public GroupContractInner withExternalId(String externalId)"
desc: "Set the externalId property: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory \\`aad://<tenant>.onmicrosoft.com/groups/<group object id>\\`; otherwise the value is null."
returns:
description: "the GroupContractInner object itself."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner?alt=com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner&text=GroupContractInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.withTypePropertiesType(com.azure.resourcemanager.apimanagement.models.GroupType)"
fullName: "com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner.withTypePropertiesType(GroupType type)"
name: "withTypePropertiesType(GroupType type)"
nameWithType: "GroupContractInner.withTypePropertiesType(GroupType type)"
summary: "Set the type property: Group type."
parameters:
- description: "the type value to set."
name: "type"
type: "<xref href=\"com.azure.resourcemanager.apimanagement.models.GroupType?alt=com.azure.resourcemanager.apimanagement.models.GroupType&text=GroupType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public GroupContractInner withTypePropertiesType(GroupType type)"
desc: "Set the type property: Group type."
returns:
description: "the GroupContractInner object itself."
type: "<xref href=\"com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner?alt=com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner&text=GroupContractInner\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Contract details."
metadata: {}
package: "com.azure.resourcemanager.apimanagement.fluent.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4