com.vmware.nsx.model

Class InstanceRuntime.Builder

java.lang.Object

com.vmware.nsx.model.InstanceRuntime.Builder

Enclosing class:

InstanceRuntime

public static final class InstanceRuntime.Builder
extends java.lang.Object

Builder class for InstanceRuntime.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of InstanceRuntime.

Method Summary

Modifier and Type	Method and Description
InstanceRuntime	build()
InstanceRuntime.Builder	setComputeCollectionId(java.lang.String computeCollectionId) Resource Pool or cluster Id.
InstanceRuntime.Builder	setCreateTime(java.lang.Long createTime) Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
InstanceRuntime.Builder	setCreateUser(java.lang.String createUser) ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
InstanceRuntime.Builder	setDeploymentStatus(java.lang.String deploymentStatus) Possible values are: InstanceRuntime.DEPLOYMENT_STATUS_DEPLOYMENT_IN_PROGRESS InstanceRuntime.DEPLOYMENT_STATUS_DEPLOYMENT_FAILED InstanceRuntime.DEPLOYMENT_STATUS_DEPLOYMENT_SUCCESSFUL InstanceRuntime.DEPLOYMENT_STATUS_UPGRADE_IN_PROGRESS InstanceRuntime.DEPLOYMENT_STATUS_UPGRADE_FAILED InstanceRuntime.DEPLOYMENT_STATUS_UNDEPLOYMENT_IN_PROGRESS InstanceRuntime.DEPLOYMENT_STATUS_UNDEPLOYMENT_FAILED InstanceRuntime.DEPLOYMENT_STATUS_UNDEPLOYMENT_SUCCESSFUL InstanceRuntime.DEPLOYMENT_STATUS_UNKNOWN Service-Instance Runtime deployment status of the Service-VM.
InstanceRuntime.Builder	setDescription(java.lang.String description) Description of this resource
InstanceRuntime.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
InstanceRuntime.Builder	setErrorMessage(java.lang.String errorMessage) Error message for the Service Instance Runtime if any.
InstanceRuntime.Builder	setId(java.lang.String id) Unique identifier of this resource
InstanceRuntime.Builder	setLastModifiedTime(java.lang.Long lastModifiedTime) Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
InstanceRuntime.Builder	setLastModifiedUser(java.lang.String lastModifiedUser) ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
InstanceRuntime.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
InstanceRuntime.Builder	setMaintenanceMode(java.lang.String maintenanceMode) Possible values are: InstanceRuntime.MAINTENANCE_MODE_OFF InstanceRuntime.MAINTENANCE_MODE_ENTERING InstanceRuntime.MAINTENANCE_MODE_ON InstanceRuntime.MAINTENANCE_MODE_EXITING The maintenance mode indicates whether the corresponding service VM is in maintenance mode.
InstanceRuntime.Builder	setProtection(java.lang.String protection) Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
InstanceRuntime.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
InstanceRuntime.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
InstanceRuntime.Builder	setRuntimeHealthStatusByPartner(java.lang.String runtimeHealthStatusByPartner) Possible values are: InstanceRuntime.RUNTIME_HEALTH_STATUS_BY_PARTNER_HEALTHY InstanceRuntime.RUNTIME_HEALTH_STATUS_BY_PARTNER_STOPPED InstanceRuntime.RUNTIME_HEALTH_STATUS_BY_PARTNER_NOT_RESPONDING Service-Instance runtime health status set by partner to indicate whether the service is running properly or not.
InstanceRuntime.Builder	setRuntimeStatus(java.lang.String runtimeStatus) Possible values are: InstanceRuntime.RUNTIME_STATUS_IN_SERVICE InstanceRuntime.RUNTIME_STATUS_OUT_OF_SERVICE InstanceRuntime.RUNTIME_STATUS_NEEDS_ATTENTION InstanceRuntime.RUNTIME_STATUS_NOT_AVAILABLE Service-Instance Runtime status of the deployed Service-VM.
InstanceRuntime.Builder	setSchema(java.lang.String schema) Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
InstanceRuntime.Builder	setSelf(SelfResourceLink self)
InstanceRuntime.Builder	setServiceInstanceId(java.lang.String serviceInstanceId) Id of an instantiation of a registered service.
InstanceRuntime.Builder	setServiceVmId(java.lang.String serviceVmId) Service-VM/SVM id of deployed virtual-machine.
InstanceRuntime.Builder	setStorageId(java.lang.String storageId) Moref of the datastore in VC.
InstanceRuntime.Builder	setSystemOwned(java.lang.Boolean systemOwned) Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
InstanceRuntime.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
InstanceRuntime.Builder	setUnhealthyReason(java.lang.String unhealthyReason) Reason provided by partner for the service being unhealthy.
InstanceRuntime.Builder	setVmNicInfo(VmNicInfo vmNicInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of InstanceRuntime.

Method Detail

setLinks

public InstanceRuntime.Builder setLinks(java.util.List<ResourceLink> links)

The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

links - New value for the property.

setSchema

public InstanceRuntime.Builder setSchema(java.lang.String schema)

Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

schema - New value for the property.

setSelf

public InstanceRuntime.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public InstanceRuntime.Builder setRevision(java.lang.Long revision)

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32

Parameters:

revision - New value for the property.

setCreateTime

public InstanceRuntime.Builder setCreateTime(java.lang.Long createTime)

Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createTime - New value for the property.

setCreateUser

public InstanceRuntime.Builder setCreateUser(java.lang.String createUser)

ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

createUser - New value for the property.

setLastModifiedTime

public InstanceRuntime.Builder setLastModifiedTime(java.lang.Long lastModifiedTime)

Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedTime - New value for the property.

setLastModifiedUser

public InstanceRuntime.Builder setLastModifiedUser(java.lang.String lastModifiedUser)

ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

lastModifiedUser - New value for the property.

setProtection

public InstanceRuntime.Builder setProtection(java.lang.String protection)

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

protection - New value for the property.

setSystemOwned

public InstanceRuntime.Builder setSystemOwned(java.lang.Boolean systemOwned)

Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

systemOwned - New value for the property.

setDescription

public InstanceRuntime.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

public InstanceRuntime.Builder setDisplayName(java.lang.String displayName)

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

public InstanceRuntime.Builder setId(java.lang.String id)

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

public InstanceRuntime.Builder setResourceType(java.lang.String resourceType)

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

public InstanceRuntime.Builder setTags(java.util.List<Tag> tags)

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setComputeCollectionId

public InstanceRuntime.Builder setComputeCollectionId(java.lang.String computeCollectionId)

Resource Pool or cluster Id. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

computeCollectionId - New value for the property.

setDeploymentStatus

public InstanceRuntime.Builder setDeploymentStatus(java.lang.String deploymentStatus)

Possible values are:

• InstanceRuntime.DEPLOYMENT_STATUS_DEPLOYMENT_IN_PROGRESS
• InstanceRuntime.DEPLOYMENT_STATUS_DEPLOYMENT_FAILED
• InstanceRuntime.DEPLOYMENT_STATUS_DEPLOYMENT_SUCCESSFUL
• InstanceRuntime.DEPLOYMENT_STATUS_UPGRADE_IN_PROGRESS
• InstanceRuntime.DEPLOYMENT_STATUS_UPGRADE_FAILED
• InstanceRuntime.DEPLOYMENT_STATUS_UNDEPLOYMENT_IN_PROGRESS
• InstanceRuntime.DEPLOYMENT_STATUS_UNDEPLOYMENT_FAILED
• InstanceRuntime.DEPLOYMENT_STATUS_UNDEPLOYMENT_SUCCESSFUL
• InstanceRuntime.DEPLOYMENT_STATUS_UNKNOWN

Service-Instance Runtime deployment status of the Service-VM. It shows the latest status during the process of deployment, redeploy, upgrade, and un-deployment of VM. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

deploymentStatus - New value for the property.

setErrorMessage

public InstanceRuntime.Builder setErrorMessage(java.lang.String errorMessage)

Error message for the Service Instance Runtime if any. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

errorMessage - New value for the property.

setMaintenanceMode

public InstanceRuntime.Builder setMaintenanceMode(java.lang.String maintenanceMode)

Possible values are:

• InstanceRuntime.MAINTENANCE_MODE_OFF
• InstanceRuntime.MAINTENANCE_MODE_ENTERING
• InstanceRuntime.MAINTENANCE_MODE_ON
• InstanceRuntime.MAINTENANCE_MODE_EXITING

The maintenance mode indicates whether the corresponding service VM is in maintenance mode. The service VM will not be used to service new requests if it is in maintenance mode. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

maintenanceMode - New value for the property.

setRuntimeHealthStatusByPartner

public InstanceRuntime.Builder setRuntimeHealthStatusByPartner(java.lang.String runtimeHealthStatusByPartner)

Possible values are:

• InstanceRuntime.RUNTIME_HEALTH_STATUS_BY_PARTNER_HEALTHY
• InstanceRuntime.RUNTIME_HEALTH_STATUS_BY_PARTNER_STOPPED
• InstanceRuntime.RUNTIME_HEALTH_STATUS_BY_PARTNER_NOT_RESPONDING

Service-Instance runtime health status set by partner to indicate whether the service is running properly or not. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

runtimeHealthStatusByPartner - New value for the property.

setRuntimeStatus

public InstanceRuntime.Builder setRuntimeStatus(java.lang.String runtimeStatus)

Possible values are:

• InstanceRuntime.RUNTIME_STATUS_IN_SERVICE
• InstanceRuntime.RUNTIME_STATUS_OUT_OF_SERVICE
• InstanceRuntime.RUNTIME_STATUS_NEEDS_ATTENTION
• InstanceRuntime.RUNTIME_STATUS_NOT_AVAILABLE

Service-Instance Runtime status of the deployed Service-VM. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

runtimeStatus - New value for the property.

setServiceInstanceId

public InstanceRuntime.Builder setServiceInstanceId(java.lang.String serviceInstanceId)

Id of an instantiation of a registered service. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

serviceInstanceId - New value for the property.

setServiceVmId

public InstanceRuntime.Builder setServiceVmId(java.lang.String serviceVmId)

Service-VM/SVM id of deployed virtual-machine. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

serviceVmId - New value for the property.

setStorageId

public InstanceRuntime.Builder setStorageId(java.lang.String storageId)

Moref of the datastore in VC. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

storageId - New value for the property.

setUnhealthyReason

public InstanceRuntime.Builder setUnhealthyReason(java.lang.String unhealthyReason)

Reason provided by partner for the service being unhealthy. This could be due to various reasons such as connectivity lost as an example. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.

Parameters:

unhealthyReason - New value for the property.

setVmNicInfo

public InstanceRuntime.Builder setVmNicInfo(VmNicInfo vmNicInfo)

Parameters:

vmNicInfo - New value for the property.

build

public InstanceRuntime build()