Package com.vmware.nsx_policy.infra.sites.enforcement_points

Interface ClusterControlPlanes

All Superinterfaces:

ClusterControlPlanesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ClusterControlPlanesStub

public interface ClusterControlPlanes
extends com.vmware.vapi.bindings.Service, ClusterControlPlanesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.sites.enforcement_points.ClusterControlPlanesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
void	delete(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, java.lang.Boolean cascade)	Delete a Cluster Control Plane Node
void	delete(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, java.lang.Boolean cascade, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Delete a Cluster Control Plane Node
void	delete(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, java.lang.Boolean cascade, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete a Cluster Control Plane Node
void	delete(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, java.lang.Boolean cascade, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete a Cluster Control Plane Node
ClusterControlPlane	get(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId)	Returns information about a specified Cluster Control Plane .
void	get(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlane> asyncCallback)	Returns information about a specified Cluster Control Plane .
void	get(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlane> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Returns information about a specified Cluster Control Plane .
ClusterControlPlane	get(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Returns information about a specified Cluster Control Plane .
ClusterControlPlaneListResult	list(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)	list all Cluster Control Planes
void	list(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlaneListResult> asyncCallback)	list all Cluster Control Planes
void	list(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlaneListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	list all Cluster Control Planes
ClusterControlPlaneListResult	list(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	list all Cluster Control Planes
ClusterControlPlane	update(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, ClusterControlPlane clusterControlPlane)	Joins a Cluster Control Plane to NSX-T
void	update(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, ClusterControlPlane clusterControlPlane, com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlane> asyncCallback)	Joins a Cluster Control Plane to NSX-T
void	update(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, ClusterControlPlane clusterControlPlane, com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlane> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Joins a Cluster Control Plane to NSX-T
ClusterControlPlane	update(java.lang.String siteId, java.lang.String enforcementpointId, java.lang.String clusterControlPlaneId, ClusterControlPlane clusterControlPlane, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Joins a Cluster Control Plane to NSX-T

Method Detail

delete

void delete(java.lang.String siteId,
            java.lang.String enforcementpointId,
            java.lang.String clusterControlPlaneId,
            java.lang.Boolean cascade)

Delete a Cluster Control Plane Node

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

Parameters:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

cascade - Flag to indicate if force delete cluster references from the firewall security policies. (optional, default to false)

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

delete

void delete(java.lang.String siteId,
            java.lang.String enforcementpointId,
            java.lang.String clusterControlPlaneId,
            java.lang.Boolean cascade,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete a Cluster Control Plane Node

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:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

cascade - Flag to indicate if force delete cluster references from the firewall security policies. (optional, default to false)

invocationConfig - Configuration for the method invocation.

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

delete

void delete(java.lang.String siteId,
            java.lang.String enforcementpointId,
            java.lang.String clusterControlPlaneId,
            java.lang.Boolean cascade,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete a Cluster Control Plane Node

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

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

Parameters:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

cascade - Flag to indicate if force delete cluster references from the firewall security policies. (optional, default to false)

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

delete

void delete(java.lang.String siteId,
            java.lang.String enforcementpointId,
            java.lang.String clusterControlPlaneId,
            java.lang.Boolean cascade,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete a Cluster Control Plane Node

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

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

Parameters:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

cascade - Flag to indicate if force delete cluster references from the firewall security policies. (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

get

ClusterControlPlane get(java.lang.String siteId,
                        java.lang.String enforcementpointId,
                        java.lang.String clusterControlPlaneId)

Returns information about a specified Cluster Control Plane .

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

Parameters:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

Returns:

com.vmware.nsx_policy.model.ClusterControlPlane

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

ClusterControlPlane get(java.lang.String siteId,
                        java.lang.String enforcementpointId,
                        java.lang.String clusterControlPlaneId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specified Cluster Control Plane .

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:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.ClusterControlPlane

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 siteId,
         java.lang.String enforcementpointId,
         java.lang.String clusterControlPlaneId,
         com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlane> asyncCallback)

Returns information about a specified Cluster Control Plane .

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

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

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

Parameters:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

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

get

void get(java.lang.String siteId,
         java.lang.String enforcementpointId,
         java.lang.String clusterControlPlaneId,
         com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlane> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specified Cluster Control Plane .

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

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

Parameters:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

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

invocationConfig - Configuration for the method invocation.

list

ClusterControlPlaneListResult list(java.lang.String siteId,
                                   java.lang.String enforcementpointId,
                                   java.lang.String cursor,
                                   java.lang.Boolean includeMarkForDeleteObjects,
                                   java.lang.String includedFields,
                                   java.lang.Long pageSize,
                                   java.lang.Boolean sortAscending,
                                   java.lang.String sortBy)

list all Cluster Control Planes

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

Parameters:

siteId - (required)

enforcementpointId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx_policy.model.ClusterControlPlaneListResult

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

list

ClusterControlPlaneListResult list(java.lang.String siteId,
                                   java.lang.String enforcementpointId,
                                   java.lang.String cursor,
                                   java.lang.Boolean includeMarkForDeleteObjects,
                                   java.lang.String includedFields,
                                   java.lang.Long pageSize,
                                   java.lang.Boolean sortAscending,
                                   java.lang.String sortBy,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

list all Cluster Control Planes

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:

siteId - (required)

enforcementpointId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.ClusterControlPlaneListResult

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

list

void list(java.lang.String siteId,
          java.lang.String enforcementpointId,
          java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlaneListResult> asyncCallback)

list all Cluster Control Planes

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

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

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

Parameters:

siteId - (required)

enforcementpointId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

list

void list(java.lang.String siteId,
          java.lang.String enforcementpointId,
          java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlaneListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

list all Cluster Control Planes

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

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

Parameters:

siteId - (required)

enforcementpointId - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

invocationConfig - Configuration for the method invocation.

update

ClusterControlPlane update(java.lang.String siteId,
                           java.lang.String enforcementpointId,
                           java.lang.String clusterControlPlaneId,
                           ClusterControlPlane clusterControlPlane)

Joins a Cluster Control Plane to NSX-T

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

Parameters:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

clusterControlPlane - (required)

Returns:

com.vmware.nsx_policy.model.ClusterControlPlane

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

update

ClusterControlPlane update(java.lang.String siteId,
                           java.lang.String enforcementpointId,
                           java.lang.String clusterControlPlaneId,
                           ClusterControlPlane clusterControlPlane,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Joins a Cluster Control Plane to NSX-T

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:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

clusterControlPlane - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.ClusterControlPlane

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

update

void update(java.lang.String siteId,
            java.lang.String enforcementpointId,
            java.lang.String clusterControlPlaneId,
            ClusterControlPlane clusterControlPlane,
            com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlane> asyncCallback)

Joins a Cluster Control Plane to NSX-T

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

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

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

Parameters:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

clusterControlPlane - (required)

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

update

void update(java.lang.String siteId,
            java.lang.String enforcementpointId,
            java.lang.String clusterControlPlaneId,
            ClusterControlPlane clusterControlPlane,
            com.vmware.vapi.bindings.client.AsyncCallback<ClusterControlPlane> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Joins a Cluster Control Plane to NSX-T

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

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

Parameters:

siteId - (required)

enforcementpointId - (required)

clusterControlPlaneId - (required)

clusterControlPlane - (required)

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

invocationConfig - Configuration for the method invocation.