com.vmware.nsx.model

Class IPSecVPNPeerEndpoint.Builder

java.lang.Object

com.vmware.nsx.model.IPSecVPNPeerEndpoint.Builder

Enclosing class:

IPSecVPNPeerEndpoint

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

Builder class for IPSecVPNPeerEndpoint.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IPSecVPNPeerEndpoint	build()
IPSecVPNPeerEndpoint.Builder	setAuthenticationMode(java.lang.String authenticationMode) Possible values are: IPSecVPNPeerEndpoint.AUTHENTICATION_MODE_PSK IPSecVPNPeerEndpoint.AUTHENTICATION_MODE_CERTIFICATE Authentication mode used for the peer authentication.
IPSecVPNPeerEndpoint.Builder	setConnectionInitiationMode(java.lang.String connectionInitiationMode) Possible values are: IPSecVPNPeerEndpoint.CONNECTION_INITIATION_MODE_INITIATOR IPSecVPNPeerEndpoint.CONNECTION_INITIATION_MODE_RESPOND_ONLY IPSecVPNPeerEndpoint.CONNECTION_INITIATION_MODE_ON_DEMAND Connection initiation mode used by local endpoint to establish ike connection with peer endpoint.
IPSecVPNPeerEndpoint.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.
IPSecVPNPeerEndpoint.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.
IPSecVPNPeerEndpoint.Builder	setDescription(java.lang.String description) Description of this resource
IPSecVPNPeerEndpoint.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
IPSecVPNPeerEndpoint.Builder	setDpdProfileId(java.lang.String dpdProfileId) Dead peer detection (DPD) profile id.
IPSecVPNPeerEndpoint.Builder	setId(java.lang.String id) Unique identifier of this resource
IPSecVPNPeerEndpoint.Builder	setIkeProfileId(java.lang.String ikeProfileId) IKE profile id to be used.
IPSecVPNPeerEndpoint.Builder	setIpsecTunnelProfileId(java.lang.String ipsecTunnelProfileId) Tunnel profile id to be used.
IPSecVPNPeerEndpoint.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.
IPSecVPNPeerEndpoint.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.
IPSecVPNPeerEndpoint.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
IPSecVPNPeerEndpoint.Builder	setPeerAddress(java.lang.String peerAddress) IPv4 or IPv6 address of peer endpoint on remote site.
IPSecVPNPeerEndpoint.Builder	setPeerId(java.lang.String peerId) Peer identifier.
IPSecVPNPeerEndpoint.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.
IPSecVPNPeerEndpoint.Builder	setPsk(java.lang.String psk) IPSec Pre-shared key.
IPSecVPNPeerEndpoint.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
IPSecVPNPeerEndpoint.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
IPSecVPNPeerEndpoint.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.
IPSecVPNPeerEndpoint.Builder	setSelf(SelfResourceLink self)
IPSecVPNPeerEndpoint.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.
IPSecVPNPeerEndpoint.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setAuthenticationMode

public IPSecVPNPeerEndpoint.Builder setAuthenticationMode(java.lang.String authenticationMode)

Possible values are:

• IPSecVPNPeerEndpoint.AUTHENTICATION_MODE_PSK
• IPSecVPNPeerEndpoint.AUTHENTICATION_MODE_CERTIFICATE

Authentication mode used for the peer authentication. For PSK (Pre Shared Key) authentication mode, 'psk' property is mandatory and for the CERTIFICATE authentication mode, 'peer_id' property is mandatory.

Parameters:

authenticationMode - New value for the property.

setConnectionInitiationMode

public IPSecVPNPeerEndpoint.Builder setConnectionInitiationMode(java.lang.String connectionInitiationMode)

Possible values are:

• IPSecVPNPeerEndpoint.CONNECTION_INITIATION_MODE_INITIATOR
• IPSecVPNPeerEndpoint.CONNECTION_INITIATION_MODE_RESPOND_ONLY
• IPSecVPNPeerEndpoint.CONNECTION_INITIATION_MODE_ON_DEMAND

Connection initiation mode used by local endpoint to establish ike connection with peer endpoint. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.

Parameters:

connectionInitiationMode - New value for the property.

setDpdProfileId

public IPSecVPNPeerEndpoint.Builder setDpdProfileId(java.lang.String dpdProfileId)

Dead peer detection (DPD) profile id. Default will be set according to system default policy.

Parameters:

dpdProfileId - New value for the property.

setIkeProfileId

public IPSecVPNPeerEndpoint.Builder setIkeProfileId(java.lang.String ikeProfileId)

IKE profile id to be used. Default will be set according to system default policy.

Parameters:

ikeProfileId - New value for the property.

setIpsecTunnelProfileId

public IPSecVPNPeerEndpoint.Builder setIpsecTunnelProfileId(java.lang.String ipsecTunnelProfileId)

Tunnel profile id to be used. By default it will point to system default profile.

Parameters:

ipsecTunnelProfileId - New value for the property.

setPeerAddress

public IPSecVPNPeerEndpoint.Builder setPeerAddress(java.lang.String peerAddress)

IPv4 or IPv6 address of peer endpoint on remote site.

Parameters:

peerAddress - New value for the property.

setPeerId

public IPSecVPNPeerEndpoint.Builder setPeerId(java.lang.String peerId)

Peer identifier.

Parameters:

peerId - New value for the property.

setPsk

public IPSecVPNPeerEndpoint.Builder setPsk(java.lang.String psk)

IPSec Pre-shared key. Maximum length of this field is 128 characters.

Parameters:

psk - New value for the property.

build

public IPSecVPNPeerEndpoint build()