PolicyServiceInstance (NSX Policy API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx_policy.model.PolicyServiceInstance

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class PolicyServiceInstance
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Represents an instance of partner Service and its configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PolicyServiceInstance.Builder
Builder class for PolicyServiceInstance.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PolicyServiceInstance.Builder` Builder class for `PolicyServiceInstance`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`DEPLOYMENT_MODE_ACTIVE_STANDBY`
`static java.lang.String`	`DEPLOYMENT_MODE_STAND_ALONE`
`static java.lang.String`	`FAILURE_POLICY_ALLOW`
`static java.lang.String`	`FAILURE_POLICY_BLOCK`
`static java.lang.String`	`TRANSPORT_TYPE_L2_BRIDGE`
`static java.lang.String`	`TRANSPORT_TYPE_L3_ROUTED`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PolicyServiceInstance()` Default constructor.
`protected`	`PolicyServiceInstance(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static PolicyServiceInstance`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static PolicyServiceInstance`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<Attribute>`	`getAttributes()` List of attributes specific to a partner for which the service is created.
`java.util.List<com.vmware.vapi.bindings.Structure>`	`getChildren()` Subtree for this type within policy tree containing nested elements.
`java.lang.String`	`getComputeId()` Id of the compute(ResourcePool) to which this service needs to be deployed.
`java.lang.String`	`getContextId()` UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.
`java.lang.Long`	`getCreateTime()` 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.
`java.lang.String`	`getCreateUser()` 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.
`java.lang.String`	`getDeploymentMode()` Possible values are: `DEPLOYMENT_MODE_STAND_ALONE` `DEPLOYMENT_MODE_ACTIVE_STANDBY` Deployment mode specifies how the partner appliance will be deployed i.e.
`java.lang.String`	`getDeploymentSpecName()` Form factor for the deployment of partner service.
`java.lang.String`	`getDeploymentTemplateName()` Template for the deployment of partnet service.
`java.lang.String`	`getDescription()` Description of this resource
`java.lang.String`	`getDisplayName()` Defaults to ID if not set
`java.lang.String`	`getFailurePolicy()` Possible values are: `FAILURE_POLICY_ALLOW` `FAILURE_POLICY_BLOCK` Failure policy for the Service VM.
`java.lang.String`	`getId()` Unique identifier of this resource
`java.lang.Long`	`getLastModifiedTime()` 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.
`java.lang.String`	`getLastModifiedUser()` 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.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.Boolean`	`getMarkedForDelete()` Intent objects are not directly deleted from the system when a delete is invoked on them.
`java.lang.String`	`getOriginSiteId()` This is a UUID generated by the system for knowing which site owns an object.
`java.lang.Boolean`	`getOverridden()` Global intent objects cannot be modified by the user.
`java.lang.String`	`getOwnerId()` This is a UUID generated by the system for knowing who owns this object.
`java.lang.String`	`getParentPath()` 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.
`java.lang.String`	`getPartnerServiceName()` Unique name of Partner Service in the Marketplace
`java.lang.String`	`getPath()` 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.
`java.lang.String`	`getPrimaryGatewayAddress()` Gateway address for primary management console.
`java.lang.String`	`getPrimaryInterfaceMgmtIp()` Management IP Address of primary interface of the Service format: address-or-block-or-range
`java.lang.String`	`getPrimaryInterfaceNetwork()` Path of the segment to which primary interface of the Service VM needs to be connected
`java.lang.String`	`getPrimaryPortgroupId()` Id of the standard or ditsributed port group for primary management console.
`java.lang.String`	`getPrimarySubnetMask()` Subnet for primary management console IP.
`java.lang.String`	`getProtection()` Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
`java.lang.String`	`getRealizationId()` This is a UUID generated by the system for realizing the entity object.
`java.lang.String`	`getRelativePath()` 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.
`java.lang.String`	`getRemotePath()` 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.
`java.lang.String`	`getResourceType()` The type of this resource.
`java.lang.Long`	`getRevision()` The _revision property describes the current revision of the resource.
`java.lang.String`	`getSchema()` 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.
`java.lang.String`	`getSecondaryGatewayAddress()` Gateway address for secondary management console.
`java.lang.String`	`getSecondaryInterfaceMgmtIp()` Management IP Address of secondary interface of the Service format: address-or-block-or-range
`java.lang.String`	`getSecondaryInterfaceNetwork()` Path of segment to which secondary interface of the Service VM needs to be connected
`java.lang.String`	`getSecondaryPortgroupId()` Id of the standard or ditsributed port group for secondary management console.
`java.lang.String`	`getSecondarySubnetMask()` Subnet for secondary management console IP.
`SelfResourceLink`	`getSelf()`
`java.lang.String`	`getStorageId()` Id of the storage(Datastore).
`java.lang.Boolean`	`getSystemOwned()` 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.
`java.util.List<Tag>`	`getTags()` Opaque identifiers meaningful to the API user
`java.lang.String`	`getTransportType()` Possible values are: `TRANSPORT_TYPE_L2_BRIDGE` `TRANSPORT_TYPE_L3_ROUTED` Transport to be used while deploying Service-VM.
`java.lang.String`	`getUniqueId()` This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
`int`	`hashCode()`
`void`	`setAttributes(java.util.List<Attribute> attributes)` List of attributes specific to a partner for which the service is created.
`void`	`setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)` Subtree for this type within policy tree containing nested elements.
`void`	`setComputeId(java.lang.String computeId)` Id of the compute(ResourcePool) to which this service needs to be deployed.
`void`	`setContextId(java.lang.String contextId)` UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.
`void`	`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.
`void`	`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.
`void`	`setDeploymentMode(java.lang.String deploymentMode)` Possible values are: `DEPLOYMENT_MODE_STAND_ALONE` `DEPLOYMENT_MODE_ACTIVE_STANDBY` Deployment mode specifies how the partner appliance will be deployed i.e.
`void`	`setDeploymentSpecName(java.lang.String deploymentSpecName)` Form factor for the deployment of partner service.
`void`	`setDeploymentTemplateName(java.lang.String deploymentTemplateName)` Template for the deployment of partnet service.
`void`	`setDescription(java.lang.String description)` Description of this resource
`void`	`setDisplayName(java.lang.String displayName)` Defaults to ID if not set
`void`	`setFailurePolicy(java.lang.String failurePolicy)` Possible values are: `FAILURE_POLICY_ALLOW` `FAILURE_POLICY_BLOCK` Failure policy for the Service VM.
`void`	`setId(java.lang.String id)` Unique identifier of this resource
`void`	`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.
`void`	`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.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setMarkedForDelete(java.lang.Boolean markedForDelete)` Intent objects are not directly deleted from the system when a delete is invoked on them.
`void`	`setOriginSiteId(java.lang.String originSiteId)` This is a UUID generated by the system for knowing which site owns an object.
`void`	`setOverridden(java.lang.Boolean overridden)` Global intent objects cannot be modified by the user.
`void`	`setOwnerId(java.lang.String ownerId)` This is a UUID generated by the system for knowing who owns this object.
`void`	`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.
`void`	`setPartnerServiceName(java.lang.String partnerServiceName)` Unique name of Partner Service in the Marketplace
`void`	`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.
`void`	`setPrimaryGatewayAddress(java.lang.String primaryGatewayAddress)` Gateway address for primary management console.
`void`	`setPrimaryInterfaceMgmtIp(java.lang.String primaryInterfaceMgmtIp)` Management IP Address of primary interface of the Service format: address-or-block-or-range
`void`	`setPrimaryInterfaceNetwork(java.lang.String primaryInterfaceNetwork)` Path of the segment to which primary interface of the Service VM needs to be connected
`void`	`setPrimaryPortgroupId(java.lang.String primaryPortgroupId)` Id of the standard or ditsributed port group for primary management console.
`void`	`setPrimarySubnetMask(java.lang.String primarySubnetMask)` Subnet for primary management console IP.
`void`	`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.
`void`	`setRealizationId(java.lang.String realizationId)` This is a UUID generated by the system for realizing the entity object.
`void`	`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.
`void`	`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.
`void`	`setResourceType(java.lang.String resourceType)` The type of this resource.
`void`	`setRevision(java.lang.Long revision)` The _revision property describes the current revision of the resource.
`void`	`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.
`void`	`setSecondaryGatewayAddress(java.lang.String secondaryGatewayAddress)` Gateway address for secondary management console.
`void`	`setSecondaryInterfaceMgmtIp(java.lang.String secondaryInterfaceMgmtIp)` Management IP Address of secondary interface of the Service format: address-or-block-or-range
`void`	`setSecondaryInterfaceNetwork(java.lang.String secondaryInterfaceNetwork)` Path of segment to which secondary interface of the Service VM needs to be connected
`void`	`setSecondaryPortgroupId(java.lang.String secondaryPortgroupId)` Id of the standard or ditsributed port group for secondary management console.
`void`	`setSecondarySubnetMask(java.lang.String secondarySubnetMask)` Subnet for secondary management console IP.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setStorageId(java.lang.String storageId)` Id of the storage(Datastore).
`void`	`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.
`void`	`setTags(java.util.List<Tag> tags)` Opaque identifiers meaningful to the API user
`void`	`setTransportType(java.lang.String transportType)` Possible values are: `TRANSPORT_TYPE_L2_BRIDGE` `TRANSPORT_TYPE_L3_ROUTED` Transport to be used while deploying Service-VM.
`void`	`setUniqueId(java.lang.String uniqueId)` This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
`java.lang.String`	`toString()`

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

- Field Detail
  - DEPLOYMENT_MODE_STAND_ALONE
```
public static final java.lang.String DEPLOYMENT_MODE_STAND_ALONE
```
    See Also:
    
    Constant Field Values
  - DEPLOYMENT_MODE_ACTIVE_STANDBY
```
public static final java.lang.String DEPLOYMENT_MODE_ACTIVE_STANDBY
```
    See Also:
    
    Constant Field Values
  - TRANSPORT_TYPE_L2_BRIDGE
```
public static final java.lang.String TRANSPORT_TYPE_L2_BRIDGE
```
    See Also:
    
    Constant Field Values
  - TRANSPORT_TYPE_L3_ROUTED
```
public static final java.lang.String TRANSPORT_TYPE_L3_ROUTED
```
    See Also:
    
    Constant Field Values
  - FAILURE_POLICY_ALLOW
```
public static final java.lang.String FAILURE_POLICY_ALLOW
```
    See Also:
    
    Constant Field Values
  - FAILURE_POLICY_BLOCK
```
public static final java.lang.String FAILURE_POLICY_BLOCK
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - PolicyServiceInstance
```
public PolicyServiceInstance()
```
    Default constructor.
  - PolicyServiceInstance
```
protected PolicyServiceInstance(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setLinks
```
public void 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.
  - getSchema
```
public java.lang.String getSchema()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setSchema
```
public void 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.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getRevision
```
public java.lang.Long getRevision()
```
    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
    
    Returns:
    
    The current value of the property.
  - setRevision
```
public void 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.
  - getCreateTime
```
public java.lang.Long getCreateTime()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setCreateTime
```
public void 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.
  - getCreateUser
```
public java.lang.String getCreateUser()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setCreateUser
```
public void 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.
  - getLastModifiedTime
```
public java.lang.Long getLastModifiedTime()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setLastModifiedTime
```
public void 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.
  - getLastModifiedUser
```
public java.lang.String getLastModifiedUser()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setLastModifiedUser
```
public void 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.
  - getProtection
```
public java.lang.String getProtection()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setProtection
```
public void 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.
  - getSystemOwned
```
public java.lang.Boolean getSystemOwned()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setSystemOwned
```
public void 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.
  - getDescription
```
public java.lang.String getDescription()
```
    Description of this resource
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description of this resource
    
    Parameters:
    
    description - New value for the property.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Defaults to ID if not set
    
    Returns:
    
    The current value of the property.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Defaults to ID if not set
    
    Parameters:
    
    displayName - New value for the property.
  - getId
```
public java.lang.String getId()
```
    Unique identifier of this resource
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier of this resource
    
    Parameters:
    
    id - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    The type of this resource.
    
    Returns:
    
    The current value of the property.
  - setResourceType
```
public void setResourceType(java.lang.String resourceType)
```
    The type of this resource.
    
    Parameters:
    
    resourceType - New value for the property.
  - getTags
```
public java.util.List<Tag> getTags()
```
    Opaque identifiers meaningful to the API user
    
    Returns:
    
    The current value of the property.
  - setTags
```
public void setTags(java.util.List<Tag> tags)
```
    Opaque identifiers meaningful to the API user
    
    Parameters:
    
    tags - New value for the property.
  - getOriginSiteId
```
public java.lang.String getOriginSiteId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setOriginSiteId
```
public void 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.
  - getOwnerId
```
public java.lang.String getOwnerId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setOwnerId
```
public void 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.
  - getParentPath
```
public java.lang.String getParentPath()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setParentPath
```
public void 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.
  - getPath
```
public java.lang.String getPath()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setPath
```
public void 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.
  - getRealizationId
```
public java.lang.String getRealizationId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setRealizationId
```
public void 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.
  - getRelativePath
```
public java.lang.String getRelativePath()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setRelativePath
```
public void 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.
  - getRemotePath
```
public java.lang.String getRemotePath()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setRemotePath
```
public void 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.
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setUniqueId
```
public void 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.
  - getChildren
```
public java.util.List<com.vmware.vapi.bindings.Structure> getChildren()
```
    Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.
    
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.
  - setChildren
```
public void 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 in ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.
  - getMarkedForDelete
```
public java.lang.Boolean getMarkedForDelete()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setMarkedForDelete
```
public void 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.
  - getOverridden
```
public java.lang.Boolean getOverridden()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setOverridden
```
public void 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.
  - getDeploymentMode
```
public java.lang.String getDeploymentMode()
```
    Possible values are:
    - DEPLOYMENT_MODE_STAND_ALONE
    - DEPLOYMENT_MODE_ACTIVE_STANDBY
    Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.
    Returns:
    
    The current value of the property.
  - setDeploymentMode
```
public void setDeploymentMode(java.lang.String deploymentMode)
```
    Possible values are:
    - DEPLOYMENT_MODE_STAND_ALONE
    - DEPLOYMENT_MODE_ACTIVE_STANDBY
    Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.
    Parameters:
    
    deploymentMode - New value for the property.
  - getPartnerServiceName
```
public java.lang.String getPartnerServiceName()
```
    Unique name of Partner Service in the Marketplace
    
    Returns:
    
    The current value of the property.
  - setPartnerServiceName
```
public void setPartnerServiceName(java.lang.String partnerServiceName)
```
    Unique name of Partner Service in the Marketplace
    
    Parameters:
    
    partnerServiceName - New value for the property.
  - getTransportType
```
public java.lang.String getTransportType()
```
    Possible values are:
    - TRANSPORT_TYPE_L2_BRIDGE
    - TRANSPORT_TYPE_L3_ROUTED
    Transport to be used while deploying Service-VM.
    Returns:
    
    The current value of the property.
  - setTransportType
```
public void setTransportType(java.lang.String transportType)
```
    Possible values are:
    - TRANSPORT_TYPE_L2_BRIDGE
    - TRANSPORT_TYPE_L3_ROUTED
    Transport to be used while deploying Service-VM.
    Parameters:
    
    transportType - New value for the property.
  - getAttributes
```
public java.util.List<Attribute> getAttributes()
```
    List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance.
    
    Returns:
    
    The current value of the property.
  - setAttributes
```
public void 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.
  - getComputeId
```
public java.lang.String getComputeId()
```
    Id of the compute(ResourcePool) to which this service needs to be deployed.
    
    Returns:
    
    The current value of the property.
  - setComputeId
```
public void 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.
  - getContextId
```
public java.lang.String getContextId()
```
    UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.
    
    Returns:
    
    The current value of the property.
  - setContextId
```
public void 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.
  - getDeploymentSpecName
```
public java.lang.String getDeploymentSpecName()
```
    Form factor for the deployment of partner service.
    
    Returns:
    
    The current value of the property.
  - setDeploymentSpecName
```
public void setDeploymentSpecName(java.lang.String deploymentSpecName)
```
    Form factor for the deployment of partner service.
    
    Parameters:
    
    deploymentSpecName - New value for the property.
  - getDeploymentTemplateName
```
public java.lang.String getDeploymentTemplateName()
```
    Template for the deployment of partnet service.
    
    Returns:
    
    The current value of the property.
  - setDeploymentTemplateName
```
public void setDeploymentTemplateName(java.lang.String deploymentTemplateName)
```
    Template for the deployment of partnet service.
    
    Parameters:
    
    deploymentTemplateName - New value for the property.
  - getFailurePolicy
```
public java.lang.String getFailurePolicy()
```
    Possible values are:
    - FAILURE_POLICY_ALLOW
    - FAILURE_POLICY_BLOCK
    Failure policy for the Service VM. If this values is not provided, it will be defaulted to FAIL_CLOSE.
    Returns:
    
    The current value of the property.
  - setFailurePolicy
```
public void setFailurePolicy(java.lang.String failurePolicy)
```
    Possible values are:
    - FAILURE_POLICY_ALLOW
    - FAILURE_POLICY_BLOCK
    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.
  - getPrimaryGatewayAddress
```
public java.lang.String getPrimaryGatewayAddress()
```
    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
    
    Returns:
    
    The current value of the property.
  - setPrimaryGatewayAddress
```
public void 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.
  - getPrimaryInterfaceMgmtIp
```
public java.lang.String getPrimaryInterfaceMgmtIp()
```
    Management IP Address of primary interface of the Service format: address-or-block-or-range
    
    Returns:
    
    The current value of the property.
  - setPrimaryInterfaceMgmtIp
```
public void 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.
  - getPrimaryInterfaceNetwork
```
public java.lang.String getPrimaryInterfaceNetwork()
```
    Path of the segment to which primary interface of the Service VM needs to be connected
    
    Returns:
    
    The current value of the property.
  - setPrimaryInterfaceNetwork
```
public void 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.
  - getPrimaryPortgroupId
```
public java.lang.String getPrimaryPortgroupId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setPrimaryPortgroupId
```
public void 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.
  - getPrimarySubnetMask
```
public java.lang.String getPrimarySubnetMask()
```
    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
    
    Returns:
    
    The current value of the property.
  - setPrimarySubnetMask
```
public void 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.
  - getSecondaryGatewayAddress
```
public java.lang.String getSecondaryGatewayAddress()
```
    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
    
    Returns:
    
    The current value of the property.
  - setSecondaryGatewayAddress
```
public void 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.
  - getSecondaryInterfaceMgmtIp
```
public java.lang.String getSecondaryInterfaceMgmtIp()
```
    Management IP Address of secondary interface of the Service format: address-or-block-or-range
    
    Returns:
    
    The current value of the property.
  - setSecondaryInterfaceMgmtIp
```
public void 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.
  - getSecondaryInterfaceNetwork
```
public java.lang.String getSecondaryInterfaceNetwork()
```
    Path of segment to which secondary interface of the Service VM needs to be connected
    
    Returns:
    
    The current value of the property.
  - setSecondaryInterfaceNetwork
```
public void 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.
  - getSecondaryPortgroupId
```
public java.lang.String getSecondaryPortgroupId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setSecondaryPortgroupId
```
public void 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.
  - getSecondarySubnetMask
```
public java.lang.String getSecondarySubnetMask()
```
    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
    
    Returns:
    
    The current value of the property.
  - setSecondarySubnetMask
```
public void 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.
  - getStorageId
```
public java.lang.String getStorageId()
```
    Id of the storage(Datastore). VC moref of Datastore to which this service needs to be deployed.
    
    Returns:
    
    The current value of the property.
  - setStorageId
```
public void 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.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static PolicyServiceInstance _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static PolicyServiceInstance _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class PolicyServiceInstance

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEPLOYMENT_MODE_STAND_ALONE

DEPLOYMENT_MODE_ACTIVE_STANDBY

TRANSPORT_TYPE_L2_BRIDGE

TRANSPORT_TYPE_L3_ROUTED

FAILURE_POLICY_ALLOW

FAILURE_POLICY_BLOCK

__dynamicStructureFields

Constructor Detail

PolicyServiceInstance

PolicyServiceInstance

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getRevision

setRevision

getCreateTime

setCreateTime

getCreateUser

setCreateUser

getLastModifiedTime

setLastModifiedTime

getLastModifiedUser

setLastModifiedUser

getProtection

setProtection

getSystemOwned

setSystemOwned

getDescription

setDescription

getDisplayName

setDisplayName

getId

setId

getResourceType

setResourceType

getTags

setTags

getOriginSiteId

setOriginSiteId

getOwnerId

setOwnerId

getParentPath

setParentPath

getPath

setPath

getRealizationId

setRealizationId

getRelativePath

setRelativePath

getRemotePath

setRemotePath

getUniqueId

setUniqueId

getChildren

setChildren

getMarkedForDelete

setMarkedForDelete

getOverridden

setOverridden

getDeploymentMode

setDeploymentMode

getPartnerServiceName

setPartnerServiceName

getTransportType

setTransportType

getAttributes

setAttributes

getComputeId

setComputeId