ComputeNode Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. ComputeNode
- com.
public class ComputeNode
A Compute Node in the Batch service.
Constructor Summary
Constructor | Description | |
---|---|---|
ComputeNode() |
Method Summary
Modifier and Type | Method and Description |
---|---|
String |
affinityId()
Get note that this is just a soft affinity. |
org.joda.time.DateTime |
allocationTime()
Get this is the time when the Compute Node was initially allocated and doesn't change once set. |
List<Certificate |
certificateReferences()
Get for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. |
Compute |
endpointConfiguration()
Get the endpoint |
List<Compute |
errors()
Get the errors value. |
String |
id()
Get every Compute Node that is added to a Pool is assigned a unique ID. |
String |
ipAddress()
Get every Compute Node that is added to a Pool is assigned a unique IP address. |
Boolean |
isDedicated()
Get the is |
org.joda.time.DateTime |
lastBootTime()
Get this property may not be present if the Compute Node state is unusable. |
Node |
nodeAgentInfo()
Get the node |
List<Task |
recentTasks()
Get this property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool. |
Integer |
runningTaskSlotsCount()
Get the running |
Integer |
runningTasksCount()
Get the running |
Scheduling |
schedulingState()
Get possible values include: 'enabled', 'disabled'. |
Start |
startTask()
Get the start |
Start |
startTaskInfo()
Get the start |
Compute |
state()
Get the Spot/Low-priority Compute Node has been preempted. |
org.joda.time.DateTime |
stateTransitionTime()
Get the state |
Integer |
totalTasksRun()
Get the total |
Integer |
totalTasksSucceeded()
Get the total |
String |
url()
Get the url value. |
Virtual |
virtualMachineInfo()
Get the virtual |
String |
vmSize()
Get for information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs. |
Compute |
withAffinityId(String affinityId)
Set note that this is just a soft affinity. |
Compute |
withAllocationTime(DateTime allocationTime)
Set this is the time when the Compute Node was initially allocated and doesn't change once set. |
Compute |
withCertificateReferences(List<CertificateReference> certificateReferences)
Set for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. |
Compute |
withEndpointConfiguration(ComputeNodeEndpointConfiguration endpointConfiguration)
Set the endpoint |
Compute |
withErrors(List<ComputeNodeError> errors)
Set the errors value. |
Compute |
withId(String id)
Set every Compute Node that is added to a Pool is assigned a unique ID. |
Compute |
withIpAddress(String ipAddress)
Set every Compute Node that is added to a Pool is assigned a unique IP address. |
Compute |
withIsDedicated(Boolean isDedicated)
Set the is |
Compute |
withLastBootTime(DateTime lastBootTime)
Set this property may not be present if the Compute Node state is unusable. |
Compute |
withNodeAgentInfo(NodeAgentInformation nodeAgentInfo)
Set the node |
Compute |
withRecentTasks(List<TaskInformation> recentTasks)
Set this property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool. |
Compute |
withRunningTaskSlotsCount(Integer runningTaskSlotsCount)
Set the running |
Compute |
withRunningTasksCount(Integer runningTasksCount)
Set the running |
Compute |
withSchedulingState(SchedulingState schedulingState)
Set possible values include: 'enabled', 'disabled'. |
Compute |
withStartTask(StartTask startTask)
Set the start |
Compute |
withStartTaskInfo(StartTaskInformation startTaskInfo)
Set the start |
Compute |
withState(ComputeNodeState state)
Set the Spot/Low-priority Compute Node has been preempted. |
Compute |
withStateTransitionTime(DateTime stateTransitionTime)
Set the state |
Compute |
withTotalTasksRun(Integer totalTasksRun)
Set the total |
Compute |
withTotalTasksSucceeded(Integer totalTasksSucceeded)
Set the total |
Compute |
withUrl(String url)
Set the url value. |
Compute |
withVirtualMachineInfo(VirtualMachineInfo virtualMachineInfo)
Set the virtual |
Compute |
withVmSize(String vmSize)
Set for information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs. |
Methods inherited from java.lang.Object
Constructor Details
ComputeNode
public ComputeNode()
Method Details
affinityId
public String affinityId()
Get note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere.
Returns:
allocationTime
public DateTime allocationTime()
Get this is the time when the Compute Node was initially allocated and doesn't change once set. It is not updated when the Compute Node is service healed or preempted.
Returns:
certificateReferences
public List
Get for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory. Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://video2.skills-academy.com/azure/batch/batch-certificate-migration-guide) instead.
Returns:
endpointConfiguration
public ComputeNodeEndpointConfiguration endpointConfiguration()
Get the endpointConfiguration value.
Returns:
errors
public List
Get the errors value.
Returns:
id
public String id()
Get every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute Nodes.
Returns:
ipAddress
public String ipAddress()
Get every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new Compute Nodes.
Returns:
isDedicated
public Boolean isDedicated()
Get the isDedicated value.
Returns:
lastBootTime
public DateTime lastBootTime()
Get this property may not be present if the Compute Node state is unusable.
Returns:
nodeAgentInfo
public NodeAgentInformation nodeAgentInfo()
Get the nodeAgentInfo value.
Returns:
recentTasks
public List
Get this property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool.
Returns:
runningTaskSlotsCount
public Integer runningTaskSlotsCount()
Get the runningTaskSlotsCount value.
Returns:
runningTasksCount
public Integer runningTasksCount()
Get the runningTasksCount value.
Returns:
schedulingState
public SchedulingState schedulingState()
Get possible values include: 'enabled', 'disabled'.
Returns:
startTask
public StartTask startTask()
Get the startTask value.
Returns:
startTaskInfo
public StartTaskInformation startTaskInfo()
Get the startTaskInfo value.
Returns:
state
public ComputeNodeState state()
Get the Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available. Possible values include: 'idle', 'rebooting', 'reimaging', 'running', 'unusable', 'creating', 'starting', 'waitingForStartTask', 'startTaskFailed', 'unknown', 'leavingPool', 'offline', 'preempted', 'upgradingOS', 'deallocated', 'deallocating'.
Returns:
stateTransitionTime
public DateTime stateTransitionTime()
Get the stateTransitionTime value.
Returns:
totalTasksRun
public Integer totalTasksRun()
Get the totalTasksRun value.
Returns:
totalTasksSucceeded
public Integer totalTasksSucceeded()
Get the totalTasksSucceeded value.
Returns:
url
public String url()
Get the url value.
Returns:
virtualMachineInfo
public VirtualMachineInfo virtualMachineInfo()
Get the virtualMachineInfo value.
Returns:
vmSize
public String vmSize()
Get for information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
Returns:
withAffinityId
public ComputeNode withAffinityId(String affinityId)
Set note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere.
Parameters:
Returns:
withAllocationTime
public ComputeNode withAllocationTime(DateTime allocationTime)
Set this is the time when the Compute Node was initially allocated and doesn't change once set. It is not updated when the Compute Node is service healed or preempted.
Parameters:
Returns:
withCertificateReferences
public ComputeNode withCertificateReferences(List
Set for Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory. Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://video2.skills-academy.com/azure/batch/batch-certificate-migration-guide) instead.
Parameters:
Returns:
withEndpointConfiguration
public ComputeNode withEndpointConfiguration(ComputeNodeEndpointConfiguration endpointConfiguration)
Set the endpointConfiguration value.
Parameters:
Returns:
withErrors
public ComputeNode withErrors(List
Set the errors value.
Parameters:
Returns:
withId
public ComputeNode withId(String id)
Set every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute Nodes.
Parameters:
Returns:
withIpAddress
public ComputeNode withIpAddress(String ipAddress)
Set every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new Compute Nodes.
Parameters:
Returns:
withIsDedicated
public ComputeNode withIsDedicated(Boolean isDedicated)
Set the isDedicated value.
Parameters:
Returns:
withLastBootTime
public ComputeNode withLastBootTime(DateTime lastBootTime)
Set this property may not be present if the Compute Node state is unusable.
Parameters:
Returns:
withNodeAgentInfo
public ComputeNode withNodeAgentInfo(NodeAgentInformation nodeAgentInfo)
Set the nodeAgentInfo value.
Parameters:
Returns:
withRecentTasks
public ComputeNode withRecentTasks(List
Set this property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool.
Parameters:
Returns:
withRunningTaskSlotsCount
public ComputeNode withRunningTaskSlotsCount(Integer runningTaskSlotsCount)
Set the runningTaskSlotsCount value.
Parameters:
Returns:
withRunningTasksCount
public ComputeNode withRunningTasksCount(Integer runningTasksCount)
Set the runningTasksCount value.
Parameters:
Returns:
withSchedulingState
public ComputeNode withSchedulingState(SchedulingState schedulingState)
Set possible values include: 'enabled', 'disabled'.
Parameters:
Returns:
withStartTask
public ComputeNode withStartTask(StartTask startTask)
Set the startTask value.
Parameters:
Returns:
withStartTaskInfo
public ComputeNode withStartTaskInfo(StartTaskInformation startTaskInfo)
Set the startTaskInfo value.
Parameters:
Returns:
withState
public ComputeNode withState(ComputeNodeState state)
Set the Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available. Possible values include: 'idle', 'rebooting', 'reimaging', 'running', 'unusable', 'creating', 'starting', 'waitingForStartTask', 'startTaskFailed', 'unknown', 'leavingPool', 'offline', 'preempted', 'upgradingOS', 'deallocated', 'deallocating'.
Parameters:
Returns:
withStateTransitionTime
public ComputeNode withStateTransitionTime(DateTime stateTransitionTime)
Set the stateTransitionTime value.
Parameters:
Returns:
withTotalTasksRun
public ComputeNode withTotalTasksRun(Integer totalTasksRun)
Set the totalTasksRun value.
Parameters:
Returns:
withTotalTasksSucceeded
public ComputeNode withTotalTasksSucceeded(Integer totalTasksSucceeded)
Set the totalTasksSucceeded value.
Parameters:
Returns:
withUrl
public ComputeNode withUrl(String url)
Set the url value.
Parameters:
Returns:
withVirtualMachineInfo
public ComputeNode withVirtualMachineInfo(VirtualMachineInfo virtualMachineInfo)
Set the virtualMachineInfo value.
Parameters:
Returns:
withVmSize
public ComputeNode withVmSize(String vmSize)
Set for information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).
Parameters:
Returns:
Applies to
Azure SDK for Java