RoleInstance (Microsoft Azure SDK for Compute Management 0.7.0 API)

java.lang.Object
- com.microsoft.windowsazure.management.compute.models.RoleInstance

public class RoleInstance
extends Object

Details of a specific role instance.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RoleInstance.PublicIP
An additional public IP that will be created for the role.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RoleInstance.PublicIP` An additional public IP that will be created for the role.

Constructor Summary

Constructors
Constructor and Description

RoleInstance()
Initializes a new instance of the RoleInstance class.

Constructors
Constructor and Description
`RoleInstance()` Initializes a new instance of the RoleInstance class.

Method Summary

Methods
Modifier and Type	Method and Description
`GuestAgentStatus`	`getGuestAgentStatus()` Optional.
`String`	`getHostName()` Optional.
`ArrayList<InstanceEndpoint>`	`getInstanceEndpoints()` Optional.
`String`	`getInstanceErrorCode()` Optional.
`Integer`	`getInstanceFaultDomain()` Optional.
`String`	`getInstanceName()` Optional.
`String`	`getInstanceSize()` Optional.
`String`	`getInstanceStateDetails()` Optional.
`String`	`getInstanceStatus()` Optional.
`Integer`	`getInstanceUpgradeDomain()` Optional.
`InetAddress`	`getIPAddress()` Optional.
`ArrayList<NetworkInterfaceInstance>`	`getNetworkInterfaces()` Optional.
`RoleInstancePowerState`	`getPowerState()` Optional.
`ArrayList<RoleInstance.PublicIP>`	`getPublicIPs()` Optional.
`String`	`getRemoteAccessCertificateThumbprint()` Optional.
`ArrayList<ResourceExtensionStatus>`	`getResourceExtensionStatusList()` Optional.
`String`	`getRoleName()` Optional.
`void`	`setGuestAgentStatus(GuestAgentStatus guestAgentStatusValue)` Optional.
`void`	`setHostName(String hostNameValue)` Optional.
`void`	`setInstanceEndpoints(ArrayList<InstanceEndpoint> instanceEndpointsValue)` Optional.
`void`	`setInstanceErrorCode(String instanceErrorCodeValue)` Optional.
`void`	`setInstanceFaultDomain(Integer instanceFaultDomainValue)` Optional.
`void`	`setInstanceName(String instanceNameValue)` Optional.
`void`	`setInstanceSize(String instanceSizeValue)` Optional.
`void`	`setInstanceStateDetails(String instanceStateDetailsValue)` Optional.
`void`	`setInstanceStatus(String instanceStatusValue)` Optional.
`void`	`setInstanceUpgradeDomain(Integer instanceUpgradeDomainValue)` Optional.
`void`	`setIPAddress(InetAddress iPAddressValue)` Optional.
`void`	`setNetworkInterfaces(ArrayList<NetworkInterfaceInstance> networkInterfacesValue)` Optional.
`void`	`setPowerState(RoleInstancePowerState powerStateValue)` Optional.
`void`	`setPublicIPs(ArrayList<RoleInstance.PublicIP> publicIPsValue)` Optional.
`void`	`setRemoteAccessCertificateThumbprint(String remoteAccessCertificateThumbprintValue)` Optional.
`void`	`setResourceExtensionStatusList(ArrayList<ResourceExtensionStatus> resourceExtensionStatusListValue)` Optional.
`void`	`setRoleName(String roleNameValue)` Optional.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RoleInstance
```
public RoleInstance()
```
    Initializes a new instance of the RoleInstance class.
- Method Detail
  - getGuestAgentStatus
```
public GuestAgentStatus getGuestAgentStatus()
```
    Optional. Guest Agent Status.
    
    Returns:
    The GuestAgentStatus value.
  - setGuestAgentStatus
```
public void setGuestAgentStatus(GuestAgentStatus guestAgentStatusValue)
```
    Optional. Guest Agent Status.
    
    Parameters:
    guestAgentStatusValue - The GuestAgentStatus value.
  - getHostName
```
public String getHostName()
```
    Optional. The DNS host name of the service in which the role instance is running. This element is only listed for Virtual Machine deployments.
    
    Returns:
    The HostName value.
  - setHostName
```
public void setHostName(String hostNameValue)
```
    Optional. The DNS host name of the service in which the role instance is running. This element is only listed for Virtual Machine deployments.
    
    Parameters:
    hostNameValue - The HostName value.
  - getInstanceEndpoints
```
public ArrayList<InstanceEndpoint> getInstanceEndpoints()
```
    Optional. The list of instance endpoints for the role.
    
    Returns:
    The InstanceEndpoints value.
  - setInstanceEndpoints
```
public void setInstanceEndpoints(ArrayList<InstanceEndpoint> instanceEndpointsValue)
```
    Optional. The list of instance endpoints for the role.
    
    Parameters:
    instanceEndpointsValue - The InstanceEndpoints value.
  - getInstanceErrorCode
```
public String getInstanceErrorCode()
```
    Optional. An error code that can be provided to Windows Azure support to assist in resolution of errors. This field will typically be empty.
    
    Returns:
    The InstanceErrorCode value.
  - setInstanceErrorCode
```
public void setInstanceErrorCode(String instanceErrorCodeValue)
```
    Optional. An error code that can be provided to Windows Azure support to assist in resolution of errors. This field will typically be empty.
    
    Parameters:
    instanceErrorCodeValue - The InstanceErrorCode value.
  - getInstanceFaultDomain
```
public Integer getInstanceFaultDomain()
```
    Optional. The fault domain that this role instance belongs to. Role instances that are part of the same fault domain may all be vulnerable to the failure of the same piece of shared hardware.
    
    Returns:
    The InstanceFaultDomain value.
  - setInstanceFaultDomain
```
public void setInstanceFaultDomain(Integer instanceFaultDomainValue)
```
    Optional. The fault domain that this role instance belongs to. Role instances that are part of the same fault domain may all be vulnerable to the failure of the same piece of shared hardware.
    
    Parameters:
    instanceFaultDomainValue - The InstanceFaultDomain value.
  - getInstanceName
```
public String getInstanceName()
```
    Optional. The name of the specific role instance, if an instance of the role is running.
    
    Returns:
    The InstanceName value.
  - setInstanceName
```
public void setInstanceName(String instanceNameValue)
```
    Optional. The name of the specific role instance, if an instance of the role is running.
    
    Parameters:
    instanceNameValue - The InstanceName value.
  - getInstanceSize
```
public String getInstanceSize()
```
    Optional. The size of the role instance.
    
    Returns:
    The InstanceSize value.
  - setInstanceSize
```
public void setInstanceSize(String instanceSizeValue)
```
    Optional. The size of the role instance.
    
    Parameters:
    instanceSizeValue - The InstanceSize value.
  - getInstanceStateDetails
```
public String getInstanceStateDetails()
```
    Optional. The instance state, returned as a string that, when present, provides a snapshot of the state of the virtual machine at the time the operation was called.
    
    Returns:
    The InstanceStateDetails value.
  - setInstanceStateDetails
```
public void setInstanceStateDetails(String instanceStateDetailsValue)
```
    Optional. The instance state, returned as a string that, when present, provides a snapshot of the state of the virtual machine at the time the operation was called.
    
    Parameters:
    instanceStateDetailsValue - The InstanceStateDetails value.
  - getInstanceStatus
```
public String getInstanceStatus()
```
    Optional. The current status of this instance.
    
    Returns:
    The InstanceStatus value.
  - setInstanceStatus
```
public void setInstanceStatus(String instanceStatusValue)
```
    Optional. The current status of this instance.
    
    Parameters:
    instanceStatusValue - The InstanceStatus value.
  - getInstanceUpgradeDomain
```
public Integer getInstanceUpgradeDomain()
```
    Optional. The update domain that this role instance belongs to. During an Upgrade Deployment, all roles in the same update domain are updated at the same time.
    
    Returns:
    The InstanceUpgradeDomain value.
  - setInstanceUpgradeDomain
```
public void setInstanceUpgradeDomain(Integer instanceUpgradeDomainValue)
```
    Optional. The update domain that this role instance belongs to. During an Upgrade Deployment, all roles in the same update domain are updated at the same time.
    
    Parameters:
    instanceUpgradeDomainValue - The InstanceUpgradeDomain value.
  - getIPAddress
```
public InetAddress getIPAddress()
```
    Optional. The IP address of the role instance (DIP).
    
    Returns:
    The IPAddress value.
  - setIPAddress
```
public void setIPAddress(InetAddress iPAddressValue)
```
    Optional. The IP address of the role instance (DIP).
    
    Parameters:
    iPAddressValue - The IPAddress value.
  - getNetworkInterfaces
```
public ArrayList<NetworkInterfaceInstance> getNetworkInterfaces()
```
    Optional.
    
    Returns:
    The NetworkInterfaces value.
  - setNetworkInterfaces
```
public void setNetworkInterfaces(ArrayList<NetworkInterfaceInstance> networkInterfacesValue)
```
    Optional.
    
    Parameters:
    networkInterfacesValue - The NetworkInterfaces value.
  - getPowerState
```
public RoleInstancePowerState getPowerState()
```
    Optional. The running state of the role instance.
    
    Returns:
    The PowerState value.
  - setPowerState
```
public void setPowerState(RoleInstancePowerState powerStateValue)
```
    Optional. The running state of the role instance.
    
    Parameters:
    powerStateValue - The PowerState value.
  - getPublicIPs
```
public ArrayList<RoleInstance.PublicIP> getPublicIPs()
```
    Optional. Optional. A set of public IPs. Currently, only one additional public IP per role is supported in an IaaS deployment. The IP address is in addition to the default VIP for the deployment.
    
    Returns:
    The PublicIPs value.
  - setPublicIPs
```
public void setPublicIPs(ArrayList<RoleInstance.PublicIP> publicIPsValue)
```
    Optional. Optional. A set of public IPs. Currently, only one additional public IP per role is supported in an IaaS deployment. The IP address is in addition to the default VIP for the deployment.
    
    Parameters:
    publicIPsValue - The PublicIPs value.
  - getRemoteAccessCertificateThumbprint
```
public String getRemoteAccessCertificateThumbprint()
```
    Optional. The thumbprint of the RDP server certificate (in Windows) or SSH server certificate (in Linux). The thumbprint is only used for Virtual Machines that have been created from an image.
    
    Returns:
    The RemoteAccessCertificateThumbprint value.
  - setRemoteAccessCertificateThumbprint
```
public void setRemoteAccessCertificateThumbprint(String remoteAccessCertificateThumbprintValue)
```
    Optional. The thumbprint of the RDP server certificate (in Windows) or SSH server certificate (in Linux). The thumbprint is only used for Virtual Machines that have been created from an image.
    
    Parameters:
    remoteAccessCertificateThumbprintValue - The RemoteAccessCertificateThumbprint value.
  - getResourceExtensionStatusList
```
public ArrayList<ResourceExtensionStatus> getResourceExtensionStatusList()
```
    Optional. Resource Extension Status List.
    
    Returns:
    The ResourceExtensionStatusList value.
  - setResourceExtensionStatusList
```
public void setResourceExtensionStatusList(ArrayList<ResourceExtensionStatus> resourceExtensionStatusListValue)
```
    Optional. Resource Extension Status List.
    
    Parameters:
    resourceExtensionStatusListValue - The ResourceExtensionStatusList value.
  - getRoleName
```
public String getRoleName()
```
    Optional. The name of the role.
    
    Returns:
    The RoleName value.
  - setRoleName
```
public void setRoleName(String roleNameValue)
```
    Optional. The name of the role.
    
    Parameters:
    roleNameValue - The RoleName value.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class RoleInstance

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RoleInstance

Method Detail

getGuestAgentStatus

setGuestAgentStatus

getHostName

setHostName

getInstanceEndpoints

setInstanceEndpoints

getInstanceErrorCode

setInstanceErrorCode

getInstanceFaultDomain

setInstanceFaultDomain

getInstanceName

setInstanceName

getInstanceSize

setInstanceSize

getInstanceStateDetails

setInstanceStateDetails

getInstanceStatus

setInstanceStatus

getInstanceUpgradeDomain

setInstanceUpgradeDomain

getIPAddress

setIPAddress

getNetworkInterfaces

setNetworkInterfaces

getPowerState

setPowerState

getPublicIPs

setPublicIPs

getRemoteAccessCertificateThumbprint

setRemoteAccessCertificateThumbprint

getResourceExtensionStatusList

setResourceExtensionStatusList

getRoleName

setRoleName