com.vmware.nsx_global_policy

Class BatchStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx_global_policy.BatchStub

All Implemented Interfaces:

Batch, BatchTypes, com.vmware.vapi.bindings.Service

public class BatchStub
extends com.vmware.vapi.internal.bindings.Stub
implements Batch

Remote stub implementation of the Batch 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_global_policy.BatchTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
BatchStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
BatchStub(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
BatchResponse	create(BatchRequest batchRequest, java.lang.Boolean atomic) Enables you to make multiple API requests using a single request.
void	create(BatchRequest batchRequest, java.lang.Boolean atomic, com.vmware.vapi.bindings.client.AsyncCallback<BatchResponse> asyncCallback) Enables you to make multiple API requests using a single request.
void	create(BatchRequest batchRequest, java.lang.Boolean atomic, com.vmware.vapi.bindings.client.AsyncCallback<BatchResponse> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Enables you to make multiple API requests using a single request.
BatchResponse	create(BatchRequest batchRequest, java.lang.Boolean atomic, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Enables you to make multiple API requests using a single request.

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

BatchStub

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

BatchStub

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

Method Detail

create

public BatchResponse create(BatchRequest batchRequest,
                            java.lang.Boolean atomic)

Description copied from interface: Batch

Enables you to make multiple API requests using a single request. The batch API takes in an array of logical HTTP requests represented as JSON arrays. Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the portion of the URL after https:///api/), optional headers array (corresponding to HTTP headers) and an optional body (for POST and PUT requests). The batch API returns an array of logical HTTP responses represented as JSON arrays. Each response has a status code, an optional headers array and an optional body (which is a JSON-encoded string). This API is deprecated. Instead, use the hierarchical API in the NSX-T policy API.
Support for batched operations will be removed from a future NSX release. For policy APIs, use the hierarchical API to submit a set of updates as a single operation. For other APIs, submit the operations as individual REST API calls.

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

Specified by:

create in interface Batch

Parameters:

batchRequest - (required)

atomic - Ignored (transactional atomicity flag) (optional, default to false)

Returns:

com.vmware.nsx_global_policy.model.BatchResponse

create

public BatchResponse create(BatchRequest batchRequest,
                            java.lang.Boolean atomic,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Batch

Enables you to make multiple API requests using a single request. The batch API takes in an array of logical HTTP requests represented as JSON arrays. Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the portion of the URL after https:///api/), optional headers array (corresponding to HTTP headers) and an optional body (for POST and PUT requests). The batch API returns an array of logical HTTP responses represented as JSON arrays. Each response has a status code, an optional headers array and an optional body (which is a JSON-encoded string). This API is deprecated. Instead, use the hierarchical API in the NSX-T policy API.
Support for batched operations will be removed from a future NSX release. For policy APIs, use the hierarchical API to submit a set of updates as a single operation. For other APIs, submit the operations as individual REST API calls.

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:

create in interface Batch

Parameters:

batchRequest - (required)

atomic - Ignored (transactional atomicity flag) (optional, default to false)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_global_policy.model.BatchResponse

create

public void create(BatchRequest batchRequest,
                   java.lang.Boolean atomic,
                   com.vmware.vapi.bindings.client.AsyncCallback<BatchResponse> asyncCallback)

Description copied from interface: Batch

Enables you to make multiple API requests using a single request. The batch API takes in an array of logical HTTP requests represented as JSON arrays. Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the portion of the URL after https:///api/), optional headers array (corresponding to HTTP headers) and an optional body (for POST and PUT requests). The batch API returns an array of logical HTTP responses represented as JSON arrays. Each response has a status code, an optional headers array and an optional body (which is a JSON-encoded string). This API is deprecated. Instead, use the hierarchical API in the NSX-T policy API.
Support for batched operations will be removed from a future NSX release. For policy APIs, use the hierarchical API to submit a set of updates as a single operation. For other APIs, submit the operations as individual REST API calls.

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

Invocation Result:
com.vmware.nsx_global_policy.model.BatchResponse

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

Specified by:

create in interface Batch

Parameters:

batchRequest - (required)

atomic - Ignored (transactional atomicity flag) (optional, default to false)

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

create

public void create(BatchRequest batchRequest,
                   java.lang.Boolean atomic,
                   com.vmware.vapi.bindings.client.AsyncCallback<BatchResponse> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Batch

Enables you to make multiple API requests using a single request. The batch API takes in an array of logical HTTP requests represented as JSON arrays. Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the portion of the URL after https:///api/), optional headers array (corresponding to HTTP headers) and an optional body (for POST and PUT requests). The batch API returns an array of logical HTTP responses represented as JSON arrays. Each response has a status code, an optional headers array and an optional body (which is a JSON-encoded string). This API is deprecated. Instead, use the hierarchical API in the NSX-T policy API.
Support for batched operations will be removed from a future NSX release. For policy APIs, use the hierarchical API to submit a set of updates as a single operation. For other APIs, submit the operations as individual REST API calls.

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_global_policy.model.BatchResponse

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

Specified by:

create in interface Batch

Parameters:

batchRequest - (required)

atomic - Ignored (transactional atomicity flag) (optional, default to false)

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

invocationConfig - Configuration for the method invocation.