Package com.vmware.nsx_policy.model
Class ServiceDefinition.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.ServiceDefinition.Builder
-
- Enclosing class:
- ServiceDefinition
public static final class ServiceDefinition.Builder extends java.lang.ObjectBuilder class forServiceDefinition.
-
-
Constructor Summary
Constructors Constructor Description Builder()Constructor with parameters for the required properties ofServiceDefinition.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ServiceDefinitionbuild()ServiceDefinition.BuildersetAttachmentPoint(java.util.List<java.lang.String> attachmentPoint)Possible values are:ServiceDefinition.ATTACHMENT_POINT_TIER0_LRServiceDefinition.ATTACHMENT_POINT_TIER1_LRServiceDefinition.ATTACHMENT_POINT_SERVICE_PLANEThe point at which the service is deployed/attached for redirecting the traffic to the the partner appliance.ServiceDefinition.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.ServiceDefinition.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.ServiceDefinition.BuildersetDescription(java.lang.String description)Description of this resourceServiceDefinition.BuildersetDisplayName(java.lang.String displayName)Defaults to ID if not setServiceDefinition.BuildersetFunctionalities(java.util.List<java.lang.String> functionalities)Possible values are:ServiceDefinition.FUNCTIONALITIES_NG_FWServiceDefinition.FUNCTIONALITIES_IDS_IPSServiceDefinition.FUNCTIONALITIES_NET_MONServiceDefinition.FUNCTIONALITIES_HCXServiceDefinition.FUNCTIONALITIES_BYODServiceDefinition.FUNCTIONALITIES_EPPServiceDefinition.FUNCTIONALITIES_TLBServiceDefinition.FUNCTIONALITIES_MPSThe capabilities provided by the services.ServiceDefinition.BuildersetId(java.lang.String id)Unique identifier of this resourceServiceDefinition.BuildersetImplementations(java.util.List<java.lang.String> implementations)Possible values are:ServiceDefinition.IMPLEMENTATIONS_NORTH_SOUTHServiceDefinition.IMPLEMENTATIONS_EAST_WESTThis indicates the insertion point of the service i.e whether the service will be used to protect North-South or East-West traffic in the datacenter.ServiceDefinition.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.ServiceDefinition.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.ServiceDefinition.BuildersetLinks(java.util.List<ResourceLink> links)The server will populate this field when returing the resource.ServiceDefinition.BuildersetOnFailurePolicy(java.lang.String onFailurePolicy)Possible values are:ServiceDefinition.ON_FAILURE_POLICY_ALLOWServiceDefinition.ON_FAILURE_POLICY_BLOCKFailure policy for the service tells datapath, the action to take i.e to Allow or Block traffic during failure scenarios.ServiceDefinition.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.ServiceDefinition.BuildersetResourceType(java.lang.String resourceType)The type of this resource.ServiceDefinition.BuildersetRevision(java.lang.Long revision)The _revision property describes the current revision of the resource.ServiceDefinition.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.ServiceDefinition.BuildersetSelf(SelfResourceLink self)ServiceDefinition.BuildersetServiceCapability(ServiceCapability serviceCapability)ServiceDefinition.BuildersetServiceDeploymentSpec(ServiceDeploymentSpec serviceDeploymentSpec)ServiceDefinition.BuildersetServiceManagerId(java.lang.String serviceManagerId)ID of the service manager to which this service is attached with.ServiceDefinition.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.ServiceDefinition.BuildersetTags(java.util.List<Tag> tags)Opaque identifiers meaningful to the API userServiceDefinition.BuildersetTransports(java.util.List<java.lang.String> transports)Possible values are:ServiceDefinition.TRANSPORTS_L2_BRIDGEServiceDefinition.TRANSPORTS_L3_ROUTEDServiceDefinition.TRANSPORTS_NSHTransport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance.ServiceDefinition.BuildersetVendorId(java.lang.String vendorId)Id which is unique to a vendor or partner for which the service is created.
-
-
-
Constructor Detail
-
Builder
public Builder()
Constructor with parameters for the required properties ofServiceDefinition.
-
-
Method Detail
-
setLinks
public ServiceDefinition.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 ServiceDefinition.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 ServiceDefinition.Builder setSelf(SelfResourceLink self)
- Parameters:
self- New value for the property.
-
setRevision
public ServiceDefinition.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 ServiceDefinition.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 ServiceDefinition.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 ServiceDefinition.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 ServiceDefinition.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 ServiceDefinition.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 ServiceDefinition.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 ServiceDefinition.Builder setDescription(java.lang.String description)
Description of this resource- Parameters:
description- New value for the property.
-
setDisplayName
public ServiceDefinition.Builder setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName- New value for the property.
-
setId
public ServiceDefinition.Builder setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id- New value for the property.
-
setResourceType
public ServiceDefinition.Builder setResourceType(java.lang.String resourceType)
The type of this resource.- Parameters:
resourceType- New value for the property.
-
setTags
public ServiceDefinition.Builder setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags- New value for the property.
-
setAttachmentPoint
public ServiceDefinition.Builder setAttachmentPoint(java.util.List<java.lang.String> attachmentPoint)
Possible values are: The point at which the service is deployed/attached for redirecting the traffic to the the partner appliance. Attachment Point is required if Service caters to any functionality other than EPP and MPS.- Parameters:
attachmentPoint- New value for the property.
-
setFunctionalities
public ServiceDefinition.Builder setFunctionalities(java.util.List<java.lang.String> functionalities)
Possible values are:-
ServiceDefinition.FUNCTIONALITIES_NG_FW -
ServiceDefinition.FUNCTIONALITIES_IDS_IPS -
ServiceDefinition.FUNCTIONALITIES_NET_MON -
ServiceDefinition.FUNCTIONALITIES_HCX -
ServiceDefinition.FUNCTIONALITIES_BYOD -
ServiceDefinition.FUNCTIONALITIES_EPP -
ServiceDefinition.FUNCTIONALITIES_TLB -
ServiceDefinition.FUNCTIONALITIES_MPS
- Parameters:
functionalities- New value for the property.
-
-
setImplementations
public ServiceDefinition.Builder setImplementations(java.util.List<java.lang.String> implementations)
Possible values are: This indicates the insertion point of the service i.e whether the service will be used to protect North-South or East-West traffic in the datacenter.- Parameters:
implementations- New value for the property.
-
setOnFailurePolicy
public ServiceDefinition.Builder setOnFailurePolicy(java.lang.String onFailurePolicy)
Possible values are: Failure policy for the service tells datapath, the action to take i.e to Allow or Block traffic during failure scenarios. For north-south ServiceInsertion, failure policy in the service instance takes precedence. For east-west ServiceInsertion, failure policy in the service chain takes precedence. BLOCK is not supported for Endpoint protection (EPP) and MPS functionality.- Parameters:
onFailurePolicy- New value for the property.
-
setServiceCapability
public ServiceDefinition.Builder setServiceCapability(ServiceCapability serviceCapability)
- Parameters:
serviceCapability- New value for the property.
-
setServiceDeploymentSpec
public ServiceDefinition.Builder setServiceDeploymentSpec(ServiceDeploymentSpec serviceDeploymentSpec)
- Parameters:
serviceDeploymentSpec- New value for the property.
-
setServiceManagerId
public ServiceDefinition.Builder setServiceManagerId(java.lang.String serviceManagerId)
ID of the service manager to which this service is attached with. This field is not set during creation of service. This field will be set explicitly when Service Manager is created successfully using this 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:
serviceManagerId- New value for the property.
-
setTransports
public ServiceDefinition.Builder setTransports(java.util.List<java.lang.String> transports)
Possible values are: Transport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance. Transport type is required if Service caters to any functionality other than EPP and MPS.- Parameters:
transports- New value for the property.
-
setVendorId
public ServiceDefinition.Builder setVendorId(java.lang.String vendorId)
Id which is unique to a vendor or partner for which the service is created.- Parameters:
vendorId- New value for the property.
-
build
public ServiceDefinition build()
-
-