com.vmware.nsx.firewall.rules

Class StateStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.firewall.rules.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.firewall.rules.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
RuleState	get(java.lang.String ruleId, java.lang.Long barrierId, java.lang.String requestId) Return realized state information of a firewall rule.
void	get(java.lang.String ruleId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.AsyncCallback<RuleState> asyncCallback) Return realized state information of a firewall rule.
void	get(java.lang.String ruleId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.AsyncCallback<RuleState> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return realized state information of a firewall rule.
RuleState	get(java.lang.String ruleId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Return realized state information of a firewall rule.

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 RuleState get(java.lang.String ruleId,
                     java.lang.Long barrierId,
                     java.lang.String requestId)

Description copied from interface: State

Return realized state information of a firewall rule. Returned response is same as rule's section realization state response.

Use the following Policy APIs -
GET /policy/api/v1/infra/realized-state/realized-entities?intent_path=/infra/domains//security-policies//rules/
GET /policy/api/v1/infra/realized-state/status?intent_path=/infra/domains//security-policies//rules/
GET /policy/api/v1/infra/realized-state/status?include_enforced_status=true&intent_path=/infra/domains//security-policies/

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

Specified by:

get in interface State

Parameters:

ruleId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

Returns:

com.vmware.nsx.model.RuleState

get

public RuleState get(java.lang.String ruleId,
                     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 firewall rule. Returned response is same as rule's section realization state response.

Use the following Policy APIs -
GET /policy/api/v1/infra/realized-state/realized-entities?intent_path=/infra/domains//security-policies//rules/
GET /policy/api/v1/infra/realized-state/status?intent_path=/infra/domains//security-policies//rules/
GET /policy/api/v1/infra/realized-state/status?include_enforced_status=true&intent_path=/infra/domains//security-policies/

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:

ruleId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.RuleState

get

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

Description copied from interface: State

Return realized state information of a firewall rule. Returned response is same as rule's section realization state response.

Use the following Policy APIs -
GET /policy/api/v1/infra/realized-state/realized-entities?intent_path=/infra/domains//security-policies//rules/
GET /policy/api/v1/infra/realized-state/status?intent_path=/infra/domains//security-policies//rules/
GET /policy/api/v1/infra/realized-state/status?include_enforced_status=true&intent_path=/infra/domains//security-policies/

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

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

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:

ruleId - (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 ruleId,
                java.lang.Long barrierId,
                java.lang.String requestId,
                com.vmware.vapi.bindings.client.AsyncCallback<RuleState> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: State

Return realized state information of a firewall rule. Returned response is same as rule's section realization state response.

Use the following Policy APIs -
GET /policy/api/v1/infra/realized-state/realized-entities?intent_path=/infra/domains//security-policies//rules/
GET /policy/api/v1/infra/realized-state/status?intent_path=/infra/domains//security-policies//rules/
GET /policy/api/v1/infra/realized-state/status?include_enforced_status=true&intent_path=/infra/domains//security-policies/

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

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:

ruleId - (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.