com.vmware.nsx.model

Class ServiceInstance.Builder

java.lang.Object

com.vmware.nsx.model.ServiceInstance.Builder

Enclosing class:

ServiceInstance

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

Builder class for ServiceInstance.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ServiceInstance	build()
ServiceInstance.Builder	setAttachmentPoint(java.lang.String attachmentPoint) Possible values are: ServiceInstance.ATTACHMENT_POINT_TIER0_LR ServiceInstance.ATTACHMENT_POINT_TIER1_LR ServiceInstance.ATTACHMENT_POINT_SERVICE_PLANE ServiceInstance.ATTACHMENT_POINT_HOST Attachment point to be used by this service instance for deploying the Service-VM.
ServiceInstance.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.
ServiceInstance.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.
ServiceInstance.Builder	setDeployedTo(java.util.List<ResourceReference> deployedTo) List of resource references where service instance be deployed.
ServiceInstance.Builder	setDeploymentMode(java.lang.String deploymentMode) Possible values are: ServiceInstance.DEPLOYMENT_MODE_STAND_ALONE ServiceInstance.DEPLOYMENT_MODE_ACTIVE_STANDBY Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.
ServiceInstance.Builder	setDeploymentSpecName(java.lang.String deploymentSpecName) Name of the deployment spec to be used by this service instance.
ServiceInstance.Builder	setDescription(java.lang.String description) Description of this resource
ServiceInstance.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ServiceInstance.Builder	setId(java.lang.String id) Unique identifier of this resource
ServiceInstance.Builder	setImplementationType(java.lang.String implementationType) Possible values are: ServiceInstance.IMPLEMENTATION_TYPE_NORTH_SOUTH ServiceInstance.IMPLEMENTATION_TYPE_EAST_WEST Implementation to be used by this service instance for deploying the Service-VM.
ServiceInstance.Builder	setInstanceDeploymentConfig(InstanceDeploymentConfig instanceDeploymentConfig)
ServiceInstance.Builder	setInstanceDeploymentTemplate(DeploymentTemplate instanceDeploymentTemplate)
ServiceInstance.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.
ServiceInstance.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.
ServiceInstance.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ServiceInstance.Builder	setOnFailurePolicy(java.lang.String onFailurePolicy) Possible values are: BaseServiceInstance.ON_FAILURE_POLICY_ALLOW BaseServiceInstance.ON_FAILURE_POLICY_BLOCK Failure policy of the service instance - if it has to be different from the service.
ServiceInstance.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.
ServiceInstance.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ServiceInstance.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.
ServiceInstance.Builder	setSelf(SelfResourceLink self)
ServiceInstance.Builder	setServiceDeploymentId(java.lang.String serviceDeploymentId) Id of the Service Deployment using which the instances were deployed.
ServiceInstance.Builder	setServiceId(java.lang.String serviceId) The Service to which the service instance is associated.
ServiceInstance.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.
ServiceInstance.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ServiceInstance.Builder	setTransportType(java.lang.String transportType) Possible values are: BaseServiceInstance.TRANSPORT_TYPE_L2_BRIDGE BaseServiceInstance.TRANSPORT_TYPE_L3_ROUTED BaseServiceInstance.TRANSPORT_TYPE_NSH BaseServiceInstance.TRANSPORT_TYPE_NA Transport to be used by this service instance for deploying the Service-VM.

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 ServiceInstance.

Method Detail

setAttachmentPoint

public ServiceInstance.Builder setAttachmentPoint(java.lang.String attachmentPoint)

Possible values are:

• ServiceInstance.ATTACHMENT_POINT_TIER0_LR
• ServiceInstance.ATTACHMENT_POINT_TIER1_LR
• ServiceInstance.ATTACHMENT_POINT_SERVICE_PLANE
• ServiceInstance.ATTACHMENT_POINT_HOST

Attachment point to be used by this service instance for deploying the Service-VM.

Parameters:

attachmentPoint - New value for the property.

setDeployedTo

public ServiceInstance.Builder setDeployedTo(java.util.List<ResourceReference> deployedTo)

List of resource references where service instance be deployed. Ex. Tier 0 Logical Router in case of N-S ServiceInsertion.

Parameters:

deployedTo - New value for the property.

setDeploymentMode

public ServiceInstance.Builder setDeploymentMode(java.lang.String deploymentMode)

Possible values are:

• ServiceInstance.DEPLOYMENT_MODE_STAND_ALONE
• ServiceInstance.DEPLOYMENT_MODE_ACTIVE_STANDBY

Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.

Parameters:

deploymentMode - New value for the property.

setDeploymentSpecName

public ServiceInstance.Builder setDeploymentSpecName(java.lang.String deploymentSpecName)

Name of the deployment spec to be used by this service instance.

Parameters:

deploymentSpecName - New value for the property.

setImplementationType

public ServiceInstance.Builder setImplementationType(java.lang.String implementationType)

Possible values are:

• ServiceInstance.IMPLEMENTATION_TYPE_NORTH_SOUTH
• ServiceInstance.IMPLEMENTATION_TYPE_EAST_WEST

Implementation to be used by this service instance for deploying the Service-VM.

Parameters:

implementationType - New value for the property.

setInstanceDeploymentConfig

public ServiceInstance.Builder setInstanceDeploymentConfig(InstanceDeploymentConfig instanceDeploymentConfig)

Parameters:

instanceDeploymentConfig - New value for the property.

setInstanceDeploymentTemplate

public ServiceInstance.Builder setInstanceDeploymentTemplate(DeploymentTemplate instanceDeploymentTemplate)

Parameters:

instanceDeploymentTemplate - New value for the property.

setServiceDeploymentId

public ServiceInstance.Builder setServiceDeploymentId(java.lang.String serviceDeploymentId)

Id of the Service Deployment using which the instances were deployed. Its available only for instances that were deployed using service deployment API. 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:

serviceDeploymentId - New value for the property.

setLinks

public ServiceInstance.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 ServiceInstance.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 ServiceInstance.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public ServiceInstance.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 ServiceInstance.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 ServiceInstance.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 ServiceInstance.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 ServiceInstance.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 ServiceInstance.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 ServiceInstance.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 ServiceInstance.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOnFailurePolicy

public ServiceInstance.Builder setOnFailurePolicy(java.lang.String onFailurePolicy)

Possible values are:

• BaseServiceInstance.ON_FAILURE_POLICY_ALLOW
• BaseServiceInstance.ON_FAILURE_POLICY_BLOCK

Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.

Parameters:

onFailurePolicy - New value for the property.

setServiceId

public ServiceInstance.Builder setServiceId(java.lang.String serviceId)

The Service to which the service instance is associated. 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:

serviceId - New value for the property.

setTransportType

public ServiceInstance.Builder setTransportType(java.lang.String transportType)

Possible values are:

• BaseServiceInstance.TRANSPORT_TYPE_L2_BRIDGE
• BaseServiceInstance.TRANSPORT_TYPE_L3_ROUTED
• BaseServiceInstance.TRANSPORT_TYPE_NSH
• BaseServiceInstance.TRANSPORT_TYPE_NA

Transport to be used by this service instance for deploying the Service-VM. This field is to be set Not Applicable(NA) if the service only caters to functionality EPP(Endpoint Protection) and MPS.

Parameters:

transportType - New value for the property.

build

public ServiceInstance build()