126 строки
7.5 KiB
YAML
126 строки
7.5 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cosmos.models.Role"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Role"
|
|
name: "Role"
|
|
nameWithType: "Role"
|
|
summary: "The set of roles permitted through this Role Definition."
|
|
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 final class **Role**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.Role?alt=com.azure.resourcemanager.cosmos.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Role.Role()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Role.Role()"
|
|
name: "Role()"
|
|
nameWithType: "Role.Role()"
|
|
summary: "Creates an instance of Role class."
|
|
syntax: "public Role()"
|
|
desc: "Creates an instance of Role class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Role.db()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Role.db()"
|
|
name: "db()"
|
|
nameWithType: "Role.db()"
|
|
summary: "Get the db property: The database name the role is applied."
|
|
syntax: "public String db()"
|
|
desc: "Get the db property: The database name the role is applied."
|
|
returns:
|
|
description: "the db value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Role.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Role.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "Role.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Role from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static Role fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the Role."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of Role from the JsonReader."
|
|
returns:
|
|
description: "An instance of Role if the JsonReader was pointing to an instance of it, or null if it was pointing to\n JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.Role?alt=com.azure.resourcemanager.cosmos.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Role.role()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Role.role()"
|
|
name: "role()"
|
|
nameWithType: "Role.role()"
|
|
summary: "Get the role property: The role name."
|
|
syntax: "public String role()"
|
|
desc: "Get the role property: The role name."
|
|
returns:
|
|
description: "the role value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Role.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Role.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "Role.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Role.validate()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Role.validate()"
|
|
name: "validate()"
|
|
nameWithType: "Role.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Role.withDb(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Role.withDb(String db)"
|
|
name: "withDb(String db)"
|
|
nameWithType: "Role.withDb(String db)"
|
|
summary: "Set the db property: The database name the role is applied."
|
|
parameters:
|
|
- description: "the db value to set."
|
|
name: "db"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Role withDb(String db)"
|
|
desc: "Set the db property: The database name the role is applied."
|
|
returns:
|
|
description: "the Role object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.Role?alt=com.azure.resourcemanager.cosmos.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.Role.withRole(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.Role.withRole(String role)"
|
|
name: "withRole(String role)"
|
|
nameWithType: "Role.withRole(String role)"
|
|
summary: "Set the role property: The role name."
|
|
parameters:
|
|
- description: "the role value to set."
|
|
name: "role"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Role withRole(String role)"
|
|
desc: "Set the role property: The role name."
|
|
returns:
|
|
description: "the Role object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.Role?alt=com.azure.resourcemanager.cosmos.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The set of roles permitted through this Role Definition."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.Role?alt=com.azure.resourcemanager.cosmos.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cosmos.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.0
|