com.vmware.nsx_policy.global_infra.drafts

Interface AggregatedWithPagination

All Superinterfaces:

AggregatedWithPaginationTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

AggregatedWithPaginationStub

public interface AggregatedWithPagination
extends com.vmware.vapi.bindings.Service, AggregatedWithPaginationTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.global_infra.drafts.AggregatedWithPaginationTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
PolicyDraftPaginatedAggregatedConfigurationResult	get(java.lang.String draftId, java.lang.String requestId, java.lang.String rootPath) Get a paginated aggregated configuration of a given draft.
void	get(java.lang.String draftId, java.lang.String requestId, java.lang.String rootPath, com.vmware.vapi.bindings.client.AsyncCallback<PolicyDraftPaginatedAggregatedConfigurationResult> asyncCallback) Get a paginated aggregated configuration of a given draft.
void	get(java.lang.String draftId, java.lang.String requestId, java.lang.String rootPath, com.vmware.vapi.bindings.client.AsyncCallback<PolicyDraftPaginatedAggregatedConfigurationResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a paginated aggregated configuration of a given draft.
PolicyDraftPaginatedAggregatedConfigurationResult	get(java.lang.String draftId, java.lang.String requestId, java.lang.String rootPath, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a paginated aggregated configuration of a given draft.

Method Detail

get

PolicyDraftPaginatedAggregatedConfigurationResult get(java.lang.String draftId,
                                                      java.lang.String requestId,
                                                      java.lang.String rootPath)

Get a paginated aggregated configuration of a given draft. This aggregated configuration is the differnece between the current published firewall configuration and a firewall configuration stored in a given draft. For an initial API call, if request_id is present in a response, then this is a paginated aggregated configuration of a given draft, containing all the security policies from the aggregated configuration. Using this request_id, more granular aggregated configuration, at security policy level, can be fetched from subsequent API calls. Absence of request_id suggests that whole aggregated configuration has been returned as a response to initial API call, as the size of aggregated configuration is not big enough to need pagination.

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

Parameters:

draftId - (required)

requestId - Request identifier to track subsequent API calls (optional)

rootPath - Path of the root object of subtree (optional)

Returns:

com.vmware.nsx_policy.model.PolicyDraftPaginatedAggregatedConfigurationResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

PolicyDraftPaginatedAggregatedConfigurationResult get(java.lang.String draftId,
                                                      java.lang.String requestId,
                                                      java.lang.String rootPath,
                                                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a paginated aggregated configuration of a given draft. This aggregated configuration is the differnece between the current published firewall configuration and a firewall configuration stored in a given draft. For an initial API call, if request_id is present in a response, then this is a paginated aggregated configuration of a given draft, containing all the security policies from the aggregated configuration. Using this request_id, more granular aggregated configuration, at security policy level, can be fetched from subsequent API calls. Absence of request_id suggests that whole aggregated configuration has been returned as a response to initial API call, as the size of aggregated configuration is not big enough to need pagination.

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

Parameters:

draftId - (required)

requestId - Request identifier to track subsequent API calls (optional)

rootPath - Path of the root object of subtree (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyDraftPaginatedAggregatedConfigurationResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

void get(java.lang.String draftId,
         java.lang.String requestId,
         java.lang.String rootPath,
         com.vmware.vapi.bindings.client.AsyncCallback<PolicyDraftPaginatedAggregatedConfigurationResult> asyncCallback)

Get a paginated aggregated configuration of a given draft. This aggregated configuration is the differnece between the current published firewall configuration and a firewall configuration stored in a given draft. For an initial API call, if request_id is present in a response, then this is a paginated aggregated configuration of a given draft, containing all the security policies from the aggregated configuration. Using this request_id, more granular aggregated configuration, at security policy level, can be fetched from subsequent API calls. Absence of request_id suggests that whole aggregated configuration has been returned as a response to initial API call, as the size of aggregated configuration is not big enough to need pagination.

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

Invocation Result:
com.vmware.nsx_policy.model.PolicyDraftPaginatedAggregatedConfigurationResult

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

Parameters:

draftId - (required)

requestId - Request identifier to track subsequent API calls (optional)

rootPath - Path of the root object of subtree (optional)

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

get

void get(java.lang.String draftId,
         java.lang.String requestId,
         java.lang.String rootPath,
         com.vmware.vapi.bindings.client.AsyncCallback<PolicyDraftPaginatedAggregatedConfigurationResult> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get a paginated aggregated configuration of a given draft. This aggregated configuration is the differnece between the current published firewall configuration and a firewall configuration stored in a given draft. For an initial API call, if request_id is present in a response, then this is a paginated aggregated configuration of a given draft, containing all the security policies from the aggregated configuration. Using this request_id, more granular aggregated configuration, at security policy level, can be fetched from subsequent API calls. Absence of request_id suggests that whole aggregated configuration has been returned as a response to initial API call, as the size of aggregated configuration is not big enough to need pagination.

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_policy.model.PolicyDraftPaginatedAggregatedConfigurationResult

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

Parameters:

draftId - (required)

requestId - Request identifier to track subsequent API calls (optional)

rootPath - Path of the root object of subtree (optional)

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

invocationConfig - Configuration for the method invocation.