com.vmware.nsx.vpn.ipsec.sessions

Class StateStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.vpn.ipsec.sessions.StateStub

All Implemented Interfaces:

State, StateTypes, com.vmware.vapi.bindings.Service

public class StateStub
extends com.vmware.vapi.internal.bindings.Stub
implements State

Remote stub implementation of the State API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.vpn.ipsec.sessions.StateTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
StateStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
StateStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
IPSecVPNSessionState	get(java.lang.String ipsecVpnSessionId, java.lang.Long barrierId, java.lang.String requestId) Return realized state information of a ipsec vpn session.
void	get(java.lang.String ipsecVpnSessionId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.AsyncCallback<IPSecVPNSessionState> asyncCallback) Return realized state information of a ipsec vpn session.
void	get(java.lang.String ipsecVpnSessionId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.AsyncCallback<IPSecVPNSessionState> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return realized state information of a ipsec vpn session.
IPSecVPNSessionState	get(java.lang.String ipsecVpnSessionId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return realized state information of a ipsec vpn session.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StateStub

public StateStub(com.vmware.vapi.core.ApiProvider apiProvider,
                 com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                 com.vmware.vapi.bindings.StubConfigurationBase config)

StateStub

public StateStub(com.vmware.vapi.core.ApiProvider apiProvider,
                 com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

get

public IPSecVPNSessionState get(java.lang.String ipsecVpnSessionId,
                                java.lang.Long barrierId,
                                java.lang.String requestId)

Description copied from interface: State

Return realized state information of a ipsec vpn session. Any configuration update that affects the ipsec vpn session can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of ipsec vpn session, service, endpoints, profiles, etc. It will return a service disabled error, if the ipsec vpn service associated with the session is disabled.

Please use below Policy APIs.
GET /policy/api/v1/infra/realized-state/realized-entity?realized_path=/policy/api/v1/infra/tier-0s//ipsec-vpn-services//sessions/
GET /policy/api/v1/infra/realized-state/realized-entity?realized_path=/policy/api/v1/infra/tier-1s//ipsec-vpn-services//sessions/

Synchronous method overload. Result of the invocation will be reported as a method return value.

Specified by:

get in interface State

Parameters:

ipsecVpnSessionId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

Returns:

com.vmware.nsx.model.IPSecVPNSessionState

get

public IPSecVPNSessionState get(java.lang.String ipsecVpnSessionId,
                                java.lang.Long barrierId,
                                java.lang.String requestId,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: State

Return realized state information of a ipsec vpn session. Any configuration update that affects the ipsec vpn session can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of ipsec vpn session, service, endpoints, profiles, etc. It will return a service disabled error, if the ipsec vpn service associated with the session is disabled.

Please use below Policy APIs.
GET /policy/api/v1/infra/realized-state/realized-entity?realized_path=/policy/api/v1/infra/tier-0s//ipsec-vpn-services//sessions/
GET /policy/api/v1/infra/realized-state/realized-entity?realized_path=/policy/api/v1/infra/tier-1s//ipsec-vpn-services//sessions/

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface State

Parameters:

ipsecVpnSessionId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.IPSecVPNSessionState

get

public void get(java.lang.String ipsecVpnSessionId,
                java.lang.Long barrierId,
                java.lang.String requestId,
                com.vmware.vapi.bindings.client.AsyncCallback<IPSecVPNSessionState> asyncCallback)

Description copied from interface: State

Return realized state information of a ipsec vpn session. Any configuration update that affects the ipsec vpn session can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of ipsec vpn session, service, endpoints, profiles, etc. It will return a service disabled error, if the ipsec vpn service associated with the session is disabled.

Please use below Policy APIs.
GET /policy/api/v1/infra/realized-state/realized-entity?realized_path=/policy/api/v1/infra/tier-0s//ipsec-vpn-services//sessions/
GET /policy/api/v1/infra/realized-state/realized-entity?realized_path=/policy/api/v1/infra/tier-1s//ipsec-vpn-services//sessions/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
com.vmware.nsx.model.IPSecVPNSessionState

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

get in interface State

Parameters:

ipsecVpnSessionId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

public void get(java.lang.String ipsecVpnSessionId,
                java.lang.Long barrierId,
                java.lang.String requestId,
                com.vmware.vapi.bindings.client.AsyncCallback<IPSecVPNSessionState> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: State

Return realized state information of a ipsec vpn session. Any configuration update that affects the ipsec vpn session can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of ipsec vpn session, service, endpoints, profiles, etc. It will return a service disabled error, if the ipsec vpn service associated with the session is disabled.

Please use below Policy APIs.
GET /policy/api/v1/infra/realized-state/realized-entity?realized_path=/policy/api/v1/infra/tier-0s//ipsec-vpn-services//sessions/
GET /policy/api/v1/infra/realized-state/realized-entity?realized_path=/policy/api/v1/infra/tier-1s//ipsec-vpn-services//sessions/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
com.vmware.nsx.model.IPSecVPNSessionState

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

get in interface State

Parameters:

ipsecVpnSessionId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.