azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.h...

309 строки
21 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.hdinsight.models.Role"
fullName: "com.azure.resourcemanager.hdinsight.models.Role"
name: "Role"
nameWithType: "Role"
summary: "Describes a role on the cluster."
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**"
constructors:
- uid: "com.azure.resourcemanager.hdinsight.models.Role.Role()"
fullName: "com.azure.resourcemanager.hdinsight.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.hdinsight.models.Role.autoscaleConfiguration()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.autoscaleConfiguration()"
name: "autoscaleConfiguration()"
nameWithType: "Role.autoscaleConfiguration()"
summary: "Get the autoscale<wbr>Configuration property: The autoscale configurations."
syntax: "public Autoscale autoscaleConfiguration()"
desc: "Get the autoscaleConfiguration property: The autoscale configurations."
returns:
description: "the autoscaleConfiguration value."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Autoscale?alt=com.azure.resourcemanager.hdinsight.models.Autoscale&text=Autoscale\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.dataDisksGroups()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.dataDisksGroups()"
name: "dataDisksGroups()"
nameWithType: "Role.dataDisksGroups()"
summary: "Get the data<wbr>Disks<wbr>Groups property: The data disks groups for the role."
syntax: "public List<DataDisksGroups> dataDisksGroups()"
desc: "Get the dataDisksGroups property: The data disks groups for the role."
returns:
description: "the dataDisksGroups value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.hdinsight.models.DataDisksGroups?alt=com.azure.resourcemanager.hdinsight.models.DataDisksGroups&text=DataDisksGroups\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.encryptDataDisks()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.encryptDataDisks()"
name: "encryptDataDisks()"
nameWithType: "Role.encryptDataDisks()"
summary: "Get the encrypt<wbr>Data<wbr>Disks property: Indicates whether encrypt the data disks."
syntax: "public Boolean encryptDataDisks()"
desc: "Get the encryptDataDisks property: Indicates whether encrypt the data disks."
returns:
description: "the encryptDataDisks value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.hardwareProfile()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.hardwareProfile()"
name: "hardwareProfile()"
nameWithType: "Role.hardwareProfile()"
summary: "Get the hardware<wbr>Profile property: The hardware profile."
syntax: "public HardwareProfile hardwareProfile()"
desc: "Get the hardwareProfile property: The hardware profile."
returns:
description: "the hardwareProfile value."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.HardwareProfile?alt=com.azure.resourcemanager.hdinsight.models.HardwareProfile&text=HardwareProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.minInstanceCount()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.minInstanceCount()"
name: "minInstanceCount()"
nameWithType: "Role.minInstanceCount()"
summary: "Get the min<wbr>Instance<wbr>Count property: The minimum instance count of the cluster."
syntax: "public Integer minInstanceCount()"
desc: "Get the minInstanceCount property: The minimum instance count of the cluster."
returns:
description: "the minInstanceCount value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.name()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.name()"
name: "name()"
nameWithType: "Role.name()"
summary: "Get the name property: The name of the role."
syntax: "public String name()"
desc: "Get the name property: The name of the role."
returns:
description: "the name value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.osProfile()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.osProfile()"
name: "osProfile()"
nameWithType: "Role.osProfile()"
summary: "Get the os<wbr>Profile property: The operating system profile."
syntax: "public OsProfile osProfile()"
desc: "Get the osProfile property: The operating system profile."
returns:
description: "the osProfile value."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.OsProfile?alt=com.azure.resourcemanager.hdinsight.models.OsProfile&text=OsProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.scriptActions()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.scriptActions()"
name: "scriptActions()"
nameWithType: "Role.scriptActions()"
summary: "Get the script<wbr>Actions property: The list of script actions on the role."
syntax: "public List<ScriptAction> scriptActions()"
desc: "Get the scriptActions property: The list of script actions on the role."
returns:
description: "the scriptActions value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.hdinsight.models.ScriptAction?alt=com.azure.resourcemanager.hdinsight.models.ScriptAction&text=ScriptAction\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.targetInstanceCount()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.targetInstanceCount()"
name: "targetInstanceCount()"
nameWithType: "Role.targetInstanceCount()"
summary: "Get the target<wbr>Instance<wbr>Count property: The instance count of the cluster."
syntax: "public Integer targetInstanceCount()"
desc: "Get the targetInstanceCount property: The instance count of the cluster."
returns:
description: "the targetInstanceCount value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.vMGroupName()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.vMGroupName()"
name: "vMGroupName()"
nameWithType: "Role.vMGroupName()"
summary: "Get the v<wbr>MGroup<wbr>Name property: The name of the virtual machine group."
syntax: "public String vMGroupName()"
desc: "Get the vMGroupName property: The name of the virtual machine group."
returns:
description: "the vMGroupName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.validate()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.validate()"
name: "validate()"
nameWithType: "Role.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.hdinsight.models.Role.virtualNetworkProfile()"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.virtualNetworkProfile()"
name: "virtualNetworkProfile()"
nameWithType: "Role.virtualNetworkProfile()"
summary: "Get the virtual<wbr>Network<wbr>Profile property: The virtual network profile."
syntax: "public VirtualNetworkProfile virtualNetworkProfile()"
desc: "Get the virtualNetworkProfile property: The virtual network profile."
returns:
description: "the virtualNetworkProfile value."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.VirtualNetworkProfile?alt=com.azure.resourcemanager.hdinsight.models.VirtualNetworkProfile&text=VirtualNetworkProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withAutoscaleConfiguration(com.azure.resourcemanager.hdinsight.models.Autoscale)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withAutoscaleConfiguration(Autoscale autoscaleConfiguration)"
name: "withAutoscaleConfiguration(Autoscale autoscaleConfiguration)"
nameWithType: "Role.withAutoscaleConfiguration(Autoscale autoscaleConfiguration)"
summary: "Set the autoscale<wbr>Configuration property: The autoscale configurations."
parameters:
- description: "the autoscaleConfiguration value to set."
name: "autoscaleConfiguration"
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Autoscale?alt=com.azure.resourcemanager.hdinsight.models.Autoscale&text=Autoscale\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Role withAutoscaleConfiguration(Autoscale autoscaleConfiguration)"
desc: "Set the autoscaleConfiguration property: The autoscale configurations."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withDataDisksGroups(java.util.List<com.azure.resourcemanager.hdinsight.models.DataDisksGroups>)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withDataDisksGroups(List<DataDisksGroups> dataDisksGroups)"
name: "withDataDisksGroups(List<DataDisksGroups> dataDisksGroups)"
nameWithType: "Role.withDataDisksGroups(List<DataDisksGroups> dataDisksGroups)"
summary: "Set the data<wbr>Disks<wbr>Groups property: The data disks groups for the role."
parameters:
- description: "the dataDisksGroups value to set."
name: "dataDisksGroups"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.hdinsight.models.DataDisksGroups?alt=com.azure.resourcemanager.hdinsight.models.DataDisksGroups&text=DataDisksGroups\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Role withDataDisksGroups(List<DataDisksGroups> dataDisksGroups)"
desc: "Set the dataDisksGroups property: The data disks groups for the role."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withEncryptDataDisks(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withEncryptDataDisks(Boolean encryptDataDisks)"
name: "withEncryptDataDisks(Boolean encryptDataDisks)"
nameWithType: "Role.withEncryptDataDisks(Boolean encryptDataDisks)"
summary: "Set the encrypt<wbr>Data<wbr>Disks property: Indicates whether encrypt the data disks."
parameters:
- description: "the encryptDataDisks value to set."
name: "encryptDataDisks"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public Role withEncryptDataDisks(Boolean encryptDataDisks)"
desc: "Set the encryptDataDisks property: Indicates whether encrypt the data disks."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withHardwareProfile(com.azure.resourcemanager.hdinsight.models.HardwareProfile)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withHardwareProfile(HardwareProfile hardwareProfile)"
name: "withHardwareProfile(HardwareProfile hardwareProfile)"
nameWithType: "Role.withHardwareProfile(HardwareProfile hardwareProfile)"
summary: "Set the hardware<wbr>Profile property: The hardware profile."
parameters:
- description: "the hardwareProfile value to set."
name: "hardwareProfile"
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.HardwareProfile?alt=com.azure.resourcemanager.hdinsight.models.HardwareProfile&text=HardwareProfile\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Role withHardwareProfile(HardwareProfile hardwareProfile)"
desc: "Set the hardwareProfile property: The hardware profile."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withMinInstanceCount(java.lang.Integer)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withMinInstanceCount(Integer minInstanceCount)"
name: "withMinInstanceCount(Integer minInstanceCount)"
nameWithType: "Role.withMinInstanceCount(Integer minInstanceCount)"
summary: "Set the min<wbr>Instance<wbr>Count property: The minimum instance count of the cluster."
parameters:
- description: "the minInstanceCount value to set."
name: "minInstanceCount"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public Role withMinInstanceCount(Integer minInstanceCount)"
desc: "Set the minInstanceCount property: The minimum instance count of the cluster."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withName(java.lang.String)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withName(String name)"
name: "withName(String name)"
nameWithType: "Role.withName(String name)"
summary: "Set the name property: The name of the role."
parameters:
- description: "the name value to set."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Role withName(String name)"
desc: "Set the name property: The name of the role."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withOsProfile(com.azure.resourcemanager.hdinsight.models.OsProfile)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withOsProfile(OsProfile osProfile)"
name: "withOsProfile(OsProfile osProfile)"
nameWithType: "Role.withOsProfile(OsProfile osProfile)"
summary: "Set the os<wbr>Profile property: The operating system profile."
parameters:
- description: "the osProfile value to set."
name: "osProfile"
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.OsProfile?alt=com.azure.resourcemanager.hdinsight.models.OsProfile&text=OsProfile\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Role withOsProfile(OsProfile osProfile)"
desc: "Set the osProfile property: The operating system profile."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withScriptActions(java.util.List<com.azure.resourcemanager.hdinsight.models.ScriptAction>)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withScriptActions(List<ScriptAction> scriptActions)"
name: "withScriptActions(List<ScriptAction> scriptActions)"
nameWithType: "Role.withScriptActions(List<ScriptAction> scriptActions)"
summary: "Set the script<wbr>Actions property: The list of script actions on the role."
parameters:
- description: "the scriptActions value to set."
name: "scriptActions"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.hdinsight.models.ScriptAction?alt=com.azure.resourcemanager.hdinsight.models.ScriptAction&text=ScriptAction\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Role withScriptActions(List<ScriptAction> scriptActions)"
desc: "Set the scriptActions property: The list of script actions on the role."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withTargetInstanceCount(java.lang.Integer)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withTargetInstanceCount(Integer targetInstanceCount)"
name: "withTargetInstanceCount(Integer targetInstanceCount)"
nameWithType: "Role.withTargetInstanceCount(Integer targetInstanceCount)"
summary: "Set the target<wbr>Instance<wbr>Count property: The instance count of the cluster."
parameters:
- description: "the targetInstanceCount value to set."
name: "targetInstanceCount"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public Role withTargetInstanceCount(Integer targetInstanceCount)"
desc: "Set the targetInstanceCount property: The instance count of the cluster."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withVMGroupName(java.lang.String)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withVMGroupName(String vMGroupName)"
name: "withVMGroupName(String vMGroupName)"
nameWithType: "Role.withVMGroupName(String vMGroupName)"
summary: "Set the v<wbr>MGroup<wbr>Name property: The name of the virtual machine group."
parameters:
- description: "the vMGroupName value to set."
name: "vMGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Role withVMGroupName(String vMGroupName)"
desc: "Set the vMGroupName property: The name of the virtual machine group."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.hdinsight.models.Role.withVirtualNetworkProfile(com.azure.resourcemanager.hdinsight.models.VirtualNetworkProfile)"
fullName: "com.azure.resourcemanager.hdinsight.models.Role.withVirtualNetworkProfile(VirtualNetworkProfile virtualNetworkProfile)"
name: "withVirtualNetworkProfile(VirtualNetworkProfile virtualNetworkProfile)"
nameWithType: "Role.withVirtualNetworkProfile(VirtualNetworkProfile virtualNetworkProfile)"
summary: "Set the virtual<wbr>Network<wbr>Profile property: The virtual network profile."
parameters:
- description: "the virtualNetworkProfile value to set."
name: "virtualNetworkProfile"
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.VirtualNetworkProfile?alt=com.azure.resourcemanager.hdinsight.models.VirtualNetworkProfile&text=VirtualNetworkProfile\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Role withVirtualNetworkProfile(VirtualNetworkProfile virtualNetworkProfile)"
desc: "Set the virtualNetworkProfile property: The virtual network profile."
returns:
description: "the Role object itself."
type: "<xref href=\"com.azure.resourcemanager.hdinsight.models.Role?alt=com.azure.resourcemanager.hdinsight.models.Role&text=Role\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Describes a role on the cluster."
metadata: {}
package: "com.azure.resourcemanager.hdinsight.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-hdinsight:1.0.0