com.vmware.nsx.firewall.sections.rules

Class StatsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.firewall.sections.rules.StatsStub

All Implemented Interfaces:

Stats, StatsTypes, com.vmware.vapi.bindings.Service

public class StatsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Stats

Remote stub implementation of the Stats 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.sections.rules.StatsTypes

_VAPI_SERVICE_ID, GET_0_SOURCE_CACHED, GET_0_SOURCE_REALTIME, GET_SOURCE_CACHED, GET_SOURCE_REALTIME

Constructor Summary

Constructors

Constructor and Description
StatsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
StatsStub(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
FirewallStatsList	get(java.lang.String sectionId, java.lang.String source) Get aggregated statistics for all rules for a given firewall section.
void	get(java.lang.String sectionId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<FirewallStatsList> asyncCallback) Get aggregated statistics for all rules for a given firewall section.
void	get(java.lang.String sectionId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<FirewallStatsList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get aggregated statistics for all rules for a given firewall section.
FirewallStatsList	get(java.lang.String sectionId, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get aggregated statistics for all rules for a given firewall section.
FirewallStats	get0(java.lang.String sectionId, java.lang.String ruleId, java.lang.String source) Get aggregated statistics for a rule for given firewall section.
void	get0(java.lang.String sectionId, java.lang.String ruleId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<FirewallStats> asyncCallback) Get aggregated statistics for a rule for given firewall section.
void	get0(java.lang.String sectionId, java.lang.String ruleId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<FirewallStats> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get aggregated statistics for a rule for given firewall section.
FirewallStats	get0(java.lang.String sectionId, java.lang.String ruleId, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get aggregated statistics for a rule for given firewall section.

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

StatsStub

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

StatsStub

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

Method Detail

get

public FirewallStatsList get(java.lang.String sectionId,
                             java.lang.String source)

Description copied from interface: Stats

Get aggregated statistics for all rules for a given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, bytes, sessions counters and popularity index for a firewall rule and overall session count, max session count and max popularity index for all firewall rules on transport nodes or edge nodes. Aggregated statistics like maximum popularity index, maximum session count and total session count are computed with lower frequency compared to individual generic rule statistics, hence they may have a computation delay up to 15 minutes to reflect in response to this API.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//statistics

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

Specified by:

get in interface Stats

Parameters:

sectionId - (required)

source - Data source type. (optional)

Returns:

com.vmware.nsx.model.FirewallStatsList

get

public FirewallStatsList get(java.lang.String sectionId,
                             java.lang.String source,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Stats

Get aggregated statistics for all rules for a given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, bytes, sessions counters and popularity index for a firewall rule and overall session count, max session count and max popularity index for all firewall rules on transport nodes or edge nodes. Aggregated statistics like maximum popularity index, maximum session count and total session count are computed with lower frequency compared to individual generic rule statistics, hence they may have a computation delay up to 15 minutes to reflect in response to this API.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//statistics

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 Stats

Parameters:

sectionId - (required)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallStatsList

get

public void get(java.lang.String sectionId,
                java.lang.String source,
                com.vmware.vapi.bindings.client.AsyncCallback<FirewallStatsList> asyncCallback)

Description copied from interface: Stats

Get aggregated statistics for all rules for a given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, bytes, sessions counters and popularity index for a firewall rule and overall session count, max session count and max popularity index for all firewall rules on transport nodes or edge nodes. Aggregated statistics like maximum popularity index, maximum session count and total session count are computed with lower frequency compared to individual generic rule statistics, hence they may have a computation delay up to 15 minutes to reflect in response to this API.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//statistics

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

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

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

Specified by:

get in interface Stats

Parameters:

sectionId - (required)

source - Data source type. (optional)

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

get

public void get(java.lang.String sectionId,
                java.lang.String source,
                com.vmware.vapi.bindings.client.AsyncCallback<FirewallStatsList> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Stats

Get aggregated statistics for all rules for a given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, bytes, sessions counters and popularity index for a firewall rule and overall session count, max session count and max popularity index for all firewall rules on transport nodes or edge nodes. Aggregated statistics like maximum popularity index, maximum session count and total session count are computed with lower frequency compared to individual generic rule statistics, hence they may have a computation delay up to 15 minutes to reflect in response to this API.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//statistics

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

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

Specified by:

get in interface Stats

Parameters:

sectionId - (required)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.

get0

public FirewallStats get0(java.lang.String sectionId,
                          java.lang.String ruleId,
                          java.lang.String source)

Description copied from interface: Stats

Get aggregated statistics for a rule for given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, bytes, sessions counters and popularity index for a firewall rule and overall session count, max session count and max popularity index for all firewall rules on transport nodes or edge nodes. Aggregated statistics like maximum popularity index, maximum session count and total session count are computed with lower frequency compared to individual generic rule statistics, hence they may have a computation delay up to 15 minutes to reflect in response to this API.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//rules//statistics

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

Specified by:

get0 in interface Stats

Parameters:

sectionId - (required)

ruleId - (required)

source - Data source type. (optional)

Returns:

com.vmware.nsx.model.FirewallStats

get0

public FirewallStats get0(java.lang.String sectionId,
                          java.lang.String ruleId,
                          java.lang.String source,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Stats

Get aggregated statistics for a rule for given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, bytes, sessions counters and popularity index for a firewall rule and overall session count, max session count and max popularity index for all firewall rules on transport nodes or edge nodes. Aggregated statistics like maximum popularity index, maximum session count and total session count are computed with lower frequency compared to individual generic rule statistics, hence they may have a computation delay up to 15 minutes to reflect in response to this API.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//rules//statistics

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:

get0 in interface Stats

Parameters:

sectionId - (required)

ruleId - (required)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.FirewallStats

get0

public void get0(java.lang.String sectionId,
                 java.lang.String ruleId,
                 java.lang.String source,
                 com.vmware.vapi.bindings.client.AsyncCallback<FirewallStats> asyncCallback)

Description copied from interface: Stats

Get aggregated statistics for a rule for given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, bytes, sessions counters and popularity index for a firewall rule and overall session count, max session count and max popularity index for all firewall rules on transport nodes or edge nodes. Aggregated statistics like maximum popularity index, maximum session count and total session count are computed with lower frequency compared to individual generic rule statistics, hence they may have a computation delay up to 15 minutes to reflect in response to this API.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//rules//statistics

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

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

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

Specified by:

get0 in interface Stats

Parameters:

sectionId - (required)

ruleId - (required)

source - Data source type. (optional)

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

get0

public void get0(java.lang.String sectionId,
                 java.lang.String ruleId,
                 java.lang.String source,
                 com.vmware.vapi.bindings.client.AsyncCallback<FirewallStats> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Stats

Get aggregated statistics for a rule for given firewall section. The API only supports access to cached (source=cached) statistical data collected offline in the system. Data includes total number of packets, bytes, sessions counters and popularity index for a firewall rule and overall session count, max session count and max popularity index for all firewall rules on transport nodes or edge nodes. Aggregated statistics like maximum popularity index, maximum session count and total session count are computed with lower frequency compared to individual generic rule statistics, hence they may have a computation delay up to 15 minutes to reflect in response to this API.

Use the following Policy API -
GET /policy/api/v1/infra/domains//security-policies//rules//statistics

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

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

Specified by:

get0 in interface Stats

Parameters:

sectionId - (required)

ruleId - (required)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.