Class ServiceTokenOperator.ServiceTokenBuilder

java.lang.Object

com.eqixiac.equinix.fabric.model.json.creators.ServiceTokenOperator.ServiceTokenBuilder

Enclosing class:

ServiceTokenOperator

public class ServiceTokenOperator.ServiceTokenBuilder
extends Object

Author:

ianjones

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServiceTokenBuilder(Side tokenSide)

Method Summary

Modifier and Type	Method	Description
ServiceTokenOperator.ServiceTokenBuilder	allowCustomBandwidth(Boolean allowCustomBandwidth)
ServiceTokenOperator.ServiceTokenBuilder	allowRemoteConnection(Boolean allowRemoteConnection)
ServiceToken	create()
ServiceTokenOperator.ServiceTokenBuilder	dryRun()
ServiceTokenOperator.ServiceTokenBuilder	forAccessPointType(AccessPointType accessPointType)
ServiceTokenOperator.ServiceTokenBuilder	forConnectionType(ConnectionType connectionType)
ServiceTokenOperator.ServiceTokenBuilder	inProject(String projectId)
ServiceTokenOperator.ServiceTokenBuilder	ofType(ServiceTokenType serviceTokenType)
ServiceTokenOperator.ServiceTokenBuilder	onNetworkUuid(String networkUuid)	Targets a Fabric network (access point selector type NETWORK), e.g. for EVPLAN/EPLAN tokens.
ServiceTokenOperator.ServiceTokenBuilder	onPort(Port port)
ServiceTokenOperator.ServiceTokenBuilder	onPortUuid(String portUuid)
ServiceTokenOperator.ServiceTokenBuilder	onVirtualDeviceUuid(String virtualDeviceUuid)	Targets a Network Edge virtual device (access point selector type VD).
ServiceTokenOperator.ServiceTokenBuilder	usingProtocolDot1q(Integer vLanTag)
ServiceTokenOperator.ServiceTokenBuilder	usingProtocolQinQ(Integer vLanCTag, Integer vlanSTag)
ServiceTokenOperator.ServiceTokenBuilder	withBandwidthLimit(Integer bandwidthLimit)
ServiceTokenOperator.ServiceTokenBuilder	withDescription(String description)
ServiceTokenOperator.ServiceTokenBuilder	withExpirationDateTime(LocalDateTime expirationDateTime)	Sets the expiration date and time of the service token.
ServiceTokenOperator.ServiceTokenBuilder	withName(String name)
ServiceTokenOperator.ServiceTokenBuilder	withNetworkInterfaceId(Integer interfaceId)	Selects a network interface on the targeted virtual device.
ServiceTokenOperator.ServiceTokenBuilder	withNotificationEmail(String emailAddress)
ServiceTokenOperator.ServiceTokenBuilder	withSupportedBandwidths(List<Integer> supportedBandwidths)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ServiceTokenBuilder

protected ServiceTokenBuilder(Side tokenSide)

Method Details

ofType

public ServiceTokenOperator.ServiceTokenBuilder ofType(ServiceTokenType serviceTokenType)

withName

public ServiceTokenOperator.ServiceTokenBuilder withName(String name)

withDescription

public ServiceTokenOperator.ServiceTokenBuilder withDescription(String description)

withExpirationDateTime

public ServiceTokenOperator.ServiceTokenBuilder withExpirationDateTime(LocalDateTime expirationDateTime)

Sets the expiration date and time of the service token.

UTC contract: the LocalDateTime input is UTC wall clock (matching every timestamp the SDK returns, including ServiceToken.getExpirationDateTime()); it is sent verbatim with a 'Z' designator. Use LocalDateTime.now(ZoneOffset.UTC) as the base for relative expirations.

Parameters:

expirationDateTime - the expiration as UTC wall clock, sent as expirationDateTime

Returns:

this builder

inProject

public ServiceTokenOperator.ServiceTokenBuilder inProject(String projectId)

forConnectionType

public ServiceTokenOperator.ServiceTokenBuilder forConnectionType(ConnectionType connectionType)

allowRemoteConnection

public ServiceTokenOperator.ServiceTokenBuilder allowRemoteConnection(Boolean allowRemoteConnection)

allowCustomBandwidth

public ServiceTokenOperator.ServiceTokenBuilder allowCustomBandwidth(Boolean allowCustomBandwidth)

withBandwidthLimit

public ServiceTokenOperator.ServiceTokenBuilder withBandwidthLimit(Integer bandwidthLimit)

withSupportedBandwidths

public ServiceTokenOperator.ServiceTokenBuilder withSupportedBandwidths(List<Integer> supportedBandwidths)

forAccessPointType

public ServiceTokenOperator.ServiceTokenBuilder forAccessPointType(AccessPointType accessPointType)

onPortUuid

public ServiceTokenOperator.ServiceTokenBuilder onPortUuid(String portUuid)

onPort

public ServiceTokenOperator.ServiceTokenBuilder onPort(Port port)

onVirtualDeviceUuid

public ServiceTokenOperator.ServiceTokenBuilder onVirtualDeviceUuid(String virtualDeviceUuid)

Targets a Network Edge virtual device (access point selector type VD).

Parameters:

virtualDeviceUuid - the Network Edge assigned virtual device identifier

Returns:

this builder

withNetworkInterfaceId

public ServiceTokenOperator.ServiceTokenBuilder withNetworkInterfaceId(Integer interfaceId)

Selects a network interface on the targeted virtual device.

Parameters:

interfaceId - the Network Edge assigned interface identifier

Returns:

this builder

onNetworkUuid

public ServiceTokenOperator.ServiceTokenBuilder onNetworkUuid(String networkUuid)

Targets a Fabric network (access point selector type NETWORK), e.g. for EVPLAN/EPLAN tokens.

Parameters:

networkUuid - the network identifier

Returns:

this builder

usingProtocolDot1q

public ServiceTokenOperator.ServiceTokenBuilder usingProtocolDot1q(Integer vLanTag)

usingProtocolQinQ

public ServiceTokenOperator.ServiceTokenBuilder usingProtocolQinQ(Integer vLanCTag,
 Integer vlanSTag)

withNotificationEmail

public ServiceTokenOperator.ServiceTokenBuilder withNotificationEmail(String emailAddress)

dryRun

public ServiceTokenOperator.ServiceTokenBuilder dryRun()

create

public ServiceToken create()