Package com.vmware.nsx_policy.model
Class PolicyServiceInstance.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.PolicyServiceInstance.Builder
-
- Enclosing class:
- PolicyServiceInstance
public static final class PolicyServiceInstance.Builder extends java.lang.ObjectBuilder class forPolicyServiceInstance.
-
-
Constructor Summary
Constructors Constructor Description Builder()Constructor with parameters for the required properties ofPolicyServiceInstance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PolicyServiceInstancebuild()PolicyServiceInstance.BuildersetAttributes(java.util.List<Attribute> attributes)List of attributes specific to a partner for which the service is created.PolicyServiceInstance.BuildersetChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)Subtree for this type within policy tree containing nested elements.PolicyServiceInstance.BuildersetComputeId(java.lang.String computeId)Id of the compute(ResourcePool) to which this service needs to be deployed.PolicyServiceInstance.BuildersetContextId(java.lang.String contextId)UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.PolicyServiceInstance.BuildersetCreateTime(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.PolicyServiceInstance.BuildersetCreateUser(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.PolicyServiceInstance.BuildersetDeploymentMode(java.lang.String deploymentMode)Possible values are:PolicyServiceInstance.DEPLOYMENT_MODE_STAND_ALONEPolicyServiceInstance.DEPLOYMENT_MODE_ACTIVE_STANDBYDeployment mode specifies how the partner appliance will be deployed i.e.PolicyServiceInstance.BuildersetDeploymentSpecName(java.lang.String deploymentSpecName)Form factor for the deployment of partner service.PolicyServiceInstance.BuildersetDeploymentTemplateName(java.lang.String deploymentTemplateName)Template for the deployment of partnet service.PolicyServiceInstance.BuildersetDescription(java.lang.String description)Description of this resourcePolicyServiceInstance.BuildersetDisplayName(java.lang.String displayName)Defaults to ID if not setPolicyServiceInstance.BuildersetFailurePolicy(java.lang.String failurePolicy)Possible values are:PolicyServiceInstance.FAILURE_POLICY_ALLOWPolicyServiceInstance.FAILURE_POLICY_BLOCKFailure policy for the Service VM.PolicyServiceInstance.BuildersetId(java.lang.String id)Unique identifier of this resourcePolicyServiceInstance.BuildersetLastModifiedTime(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.PolicyServiceInstance.BuildersetLastModifiedUser(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.PolicyServiceInstance.BuildersetLinks(java.util.List<ResourceLink> links)The server will populate this field when returing the resource.PolicyServiceInstance.BuildersetMarkedForDelete(java.lang.Boolean markedForDelete)Intent objects are not directly deleted from the system when a delete is invoked on them.PolicyServiceInstance.BuildersetOriginSiteId(java.lang.String originSiteId)This is a UUID generated by the system for knowing which site owns an object.PolicyServiceInstance.BuildersetOverridden(java.lang.Boolean overridden)Global intent objects cannot be modified by the user.PolicyServiceInstance.BuildersetOwnerId(java.lang.String ownerId)This is a UUID generated by the system for knowing who owns this object.PolicyServiceInstance.BuildersetParentPath(java.lang.String parentPath)Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.PolicyServiceInstance.BuildersetPartnerServiceName(java.lang.String partnerServiceName)Unique name of Partner Service in the MarketplacePolicyServiceInstance.BuildersetPath(java.lang.String path)Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.PolicyServiceInstance.BuildersetPrimaryGatewayAddress(java.lang.String primaryGatewayAddress)Gateway address for primary management console.PolicyServiceInstance.BuildersetPrimaryInterfaceMgmtIp(java.lang.String primaryInterfaceMgmtIp)Management IP Address of primary interface of the Service format: address-or-block-or-rangePolicyServiceInstance.BuildersetPrimaryInterfaceNetwork(java.lang.String primaryInterfaceNetwork)Path of the segment to which primary interface of the Service VM needs to be connectedPolicyServiceInstance.BuildersetPrimaryPortgroupId(java.lang.String primaryPortgroupId)Id of the standard or ditsributed port group for primary management console.PolicyServiceInstance.BuildersetPrimarySubnetMask(java.lang.String primarySubnetMask)Subnet for primary management console IP.PolicyServiceInstance.BuildersetProtection(java.lang.String protection)Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.PolicyServiceInstance.BuildersetRealizationId(java.lang.String realizationId)This is a UUID generated by the system for realizing the entity object.PolicyServiceInstance.BuildersetRelativePath(java.lang.String relativePath)Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.PolicyServiceInstance.BuildersetRemotePath(java.lang.String remotePath)This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.PolicyServiceInstance.BuildersetResourceType(java.lang.String resourceType)The type of this resource.PolicyServiceInstance.BuildersetRevision(java.lang.Long revision)The _revision property describes the current revision of the resource.PolicyServiceInstance.BuildersetSchema(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.PolicyServiceInstance.BuildersetSecondaryGatewayAddress(java.lang.String secondaryGatewayAddress)Gateway address for secondary management console.PolicyServiceInstance.BuildersetSecondaryInterfaceMgmtIp(java.lang.String secondaryInterfaceMgmtIp)Management IP Address of secondary interface of the Service format: address-or-block-or-rangePolicyServiceInstance.BuildersetSecondaryInterfaceNetwork(java.lang.String secondaryInterfaceNetwork)Path of segment to which secondary interface of the Service VM needs to be connectedPolicyServiceInstance.BuildersetSecondaryPortgroupId(java.lang.String secondaryPortgroupId)Id of the standard or ditsributed port group for secondary management console.PolicyServiceInstance.BuildersetSecondarySubnetMask(java.lang.String secondarySubnetMask)Subnet for secondary management console IP.PolicyServiceInstance.BuildersetSelf(SelfResourceLink self)PolicyServiceInstance.BuildersetStorageId(java.lang.String storageId)Id of the storage(Datastore).PolicyServiceInstance.BuildersetSystemOwned(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.PolicyServiceInstance.BuildersetTags(java.util.List<Tag> tags)Opaque identifiers meaningful to the API userPolicyServiceInstance.BuildersetTransportType(java.lang.String transportType)Possible values are:PolicyServiceInstance.TRANSPORT_TYPE_L2_BRIDGEPolicyServiceInstance.TRANSPORT_TYPE_L3_ROUTEDTransport to be used while deploying Service-VM.PolicyServiceInstance.BuildersetUniqueId(java.lang.String uniqueId)This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
-
-
-
Constructor Detail
-
Builder
public Builder()
Constructor with parameters for the required properties ofPolicyServiceInstance.
-
-
Method Detail
-
setLinks
public PolicyServiceInstance.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 PolicyServiceInstance.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 PolicyServiceInstance.Builder setSelf(SelfResourceLink self)
- Parameters:
self- New value for the property.
-
setRevision
public PolicyServiceInstance.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 PolicyServiceInstance.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 PolicyServiceInstance.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 PolicyServiceInstance.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 PolicyServiceInstance.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 PolicyServiceInstance.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 PolicyServiceInstance.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 PolicyServiceInstance.Builder setDescription(java.lang.String description)
Description of this resource- Parameters:
description- New value for the property.
-
setDisplayName
public PolicyServiceInstance.Builder setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName- New value for the property.
-
setId
public PolicyServiceInstance.Builder setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id- New value for the property.
-
setResourceType
public PolicyServiceInstance.Builder setResourceType(java.lang.String resourceType)
The type of this resource.- Parameters:
resourceType- New value for the property.
-
setTags
public PolicyServiceInstance.Builder setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags- New value for the property.
-
setOriginSiteId
public PolicyServiceInstance.Builder setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. 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:
originSiteId- New value for the property.
-
setOwnerId
public PolicyServiceInstance.Builder setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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:
ownerId- New value for the property.
-
setParentPath
public PolicyServiceInstance.Builder setParentPath(java.lang.String parentPath)
Path of its parent 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:
parentPath- New value for the property.
-
setPath
public PolicyServiceInstance.Builder setPath(java.lang.String path)
Absolute path of this object 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:
path- New value for the property.
-
setRealizationId
public PolicyServiceInstance.Builder setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. 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:
realizationId- New value for the property.
-
setRelativePath
public PolicyServiceInstance.Builder setRelativePath(java.lang.String relativePath)
Path relative from its parent 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:
relativePath- New value for the property.
-
setRemotePath
public PolicyServiceInstance.Builder setRemotePath(java.lang.String remotePath)
This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. 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:
remotePath- New value for the property.
-
setUniqueId
public PolicyServiceInstance.Builder setUniqueId(java.lang.String uniqueId)
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. 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:
uniqueId- New value for the property.
-
setChildren
public PolicyServiceInstance.Builder setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.- Parameters:
children- New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined inChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined inChildPolicyConfigResource.
-
setMarkedForDelete
public PolicyServiceInstance.Builder setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. 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:
markedForDelete- New value for the property.
-
setOverridden
public PolicyServiceInstance.Builder setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. 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:
overridden- New value for the property.
-
setDeploymentMode
public PolicyServiceInstance.Builder setDeploymentMode(java.lang.String deploymentMode)
Possible values are: Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.- Parameters:
deploymentMode- New value for the property.
-
setPartnerServiceName
public PolicyServiceInstance.Builder setPartnerServiceName(java.lang.String partnerServiceName)
Unique name of Partner Service in the Marketplace- Parameters:
partnerServiceName- New value for the property.
-
setTransportType
public PolicyServiceInstance.Builder setTransportType(java.lang.String transportType)
Possible values are: Transport to be used while deploying Service-VM.- Parameters:
transportType- New value for the property.
-
setAttributes
public PolicyServiceInstance.Builder setAttributes(java.util.List<Attribute> attributes)
List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance.- Parameters:
attributes- New value for the property.
-
setComputeId
public PolicyServiceInstance.Builder setComputeId(java.lang.String computeId)
Id of the compute(ResourcePool) to which this service needs to be deployed.- Parameters:
computeId- New value for the property.
-
setContextId
public PolicyServiceInstance.Builder setContextId(java.lang.String contextId)
UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.- Parameters:
contextId- New value for the property.
-
setDeploymentSpecName
public PolicyServiceInstance.Builder setDeploymentSpecName(java.lang.String deploymentSpecName)
Form factor for the deployment of partner service.- Parameters:
deploymentSpecName- New value for the property.
-
setDeploymentTemplateName
public PolicyServiceInstance.Builder setDeploymentTemplateName(java.lang.String deploymentTemplateName)
Template for the deployment of partnet service.- Parameters:
deploymentTemplateName- New value for the property.
-
setFailurePolicy
public PolicyServiceInstance.Builder setFailurePolicy(java.lang.String failurePolicy)
Possible values are: Failure policy for the Service VM. If this values is not provided, it will be defaulted to FAIL_CLOSE.- Parameters:
failurePolicy- New value for the property.
-
setPrimaryGatewayAddress
public PolicyServiceInstance.Builder setPrimaryGatewayAddress(java.lang.String primaryGatewayAddress)
Gateway address for primary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided. format: address-or-block-or-range- Parameters:
primaryGatewayAddress- New value for the property.
-
setPrimaryInterfaceMgmtIp
public PolicyServiceInstance.Builder setPrimaryInterfaceMgmtIp(java.lang.String primaryInterfaceMgmtIp)
Management IP Address of primary interface of the Service format: address-or-block-or-range- Parameters:
primaryInterfaceMgmtIp- New value for the property.
-
setPrimaryInterfaceNetwork
public PolicyServiceInstance.Builder setPrimaryInterfaceNetwork(java.lang.String primaryInterfaceNetwork)
Path of the segment to which primary interface of the Service VM needs to be connected- Parameters:
primaryInterfaceNetwork- New value for the property.
-
setPrimaryPortgroupId
public PolicyServiceInstance.Builder setPrimaryPortgroupId(java.lang.String primaryPortgroupId)
Id of the standard or ditsributed port group for primary management console. Please note that only 1 of the 2 values from 1. primary_interface_network 2. primary_portgroup_id are allowed to be passed. Both can't be passed in the same request.- Parameters:
primaryPortgroupId- New value for the property.
-
setPrimarySubnetMask
public PolicyServiceInstance.Builder setPrimarySubnetMask(java.lang.String primarySubnetMask)
Subnet for primary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided. format: address-or-block-or-range- Parameters:
primarySubnetMask- New value for the property.
-
setSecondaryGatewayAddress
public PolicyServiceInstance.Builder setSecondaryGatewayAddress(java.lang.String secondaryGatewayAddress)
Gateway address for secondary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided. format: address-or-block-or-range- Parameters:
secondaryGatewayAddress- New value for the property.
-
setSecondaryInterfaceMgmtIp
public PolicyServiceInstance.Builder setSecondaryInterfaceMgmtIp(java.lang.String secondaryInterfaceMgmtIp)
Management IP Address of secondary interface of the Service format: address-or-block-or-range- Parameters:
secondaryInterfaceMgmtIp- New value for the property.
-
setSecondaryInterfaceNetwork
public PolicyServiceInstance.Builder setSecondaryInterfaceNetwork(java.lang.String secondaryInterfaceNetwork)
Path of segment to which secondary interface of the Service VM needs to be connected- Parameters:
secondaryInterfaceNetwork- New value for the property.
-
setSecondaryPortgroupId
public PolicyServiceInstance.Builder setSecondaryPortgroupId(java.lang.String secondaryPortgroupId)
Id of the standard or ditsributed port group for secondary management console. Please note that only 1 of the 2 values from 1. secondary_interface_network 2. secondary_portgroup_id are allowed to be passed. Both can't be passed in the same request.- Parameters:
secondaryPortgroupId- New value for the property.
-
setSecondarySubnetMask
public PolicyServiceInstance.Builder setSecondarySubnetMask(java.lang.String secondarySubnetMask)
Subnet for secondary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided. format: address-or-block-or-range- Parameters:
secondarySubnetMask- New value for the property.
-
setStorageId
public PolicyServiceInstance.Builder setStorageId(java.lang.String storageId)
Id of the storage(Datastore). VC moref of Datastore to which this service needs to be deployed.- Parameters:
storageId- New value for the property.
-
build
public PolicyServiceInstance build()
-
-