Package com.vmware.nsx_policy.infra.tier_0s

Interface CommunityLists

All Superinterfaces:

CommunityListsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

CommunityListsStub

public interface CommunityLists
extends com.vmware.vapi.bindings.Service, CommunityListsTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.tier_0s.CommunityListsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
void	delete(java.lang.String tier0Id, java.lang.String communityListId)	Delete a BGP community list
void	delete(java.lang.String tier0Id, java.lang.String communityListId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Delete a BGP community list
void	delete(java.lang.String tier0Id, java.lang.String communityListId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete a BGP community list
void	delete(java.lang.String tier0Id, java.lang.String communityListId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete a BGP community list
CommunityList	get(java.lang.String tier0Id, java.lang.String communityListId)	Read a BGP community list
void	get(java.lang.String tier0Id, java.lang.String communityListId, com.vmware.vapi.bindings.client.AsyncCallback<CommunityList> asyncCallback)	Read a BGP community list
void	get(java.lang.String tier0Id, java.lang.String communityListId, com.vmware.vapi.bindings.client.AsyncCallback<CommunityList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read a BGP community list
CommunityList	get(java.lang.String tier0Id, java.lang.String communityListId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read a BGP community list
CommunityListListResult	list(java.lang.String tier0Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)	Paginated list of all community lists under a tier-0
void	list(java.lang.String tier0Id, 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<CommunityListListResult> asyncCallback)	Paginated list of all community lists under a tier-0
void	list(java.lang.String tier0Id, 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<CommunityListListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Paginated list of all community lists under a tier-0
CommunityListListResult	list(java.lang.String tier0Id, 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)	Paginated list of all community lists under a tier-0
void	patch(java.lang.String tier0Id, java.lang.String communityListId, CommunityList communityList)	If a community list with the community-list-id is not already present, create a new community list.
void	patch(java.lang.String tier0Id, java.lang.String communityListId, CommunityList communityList, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	If a community list with the community-list-id is not already present, create a new community list.
void	patch(java.lang.String tier0Id, java.lang.String communityListId, CommunityList communityList, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	If a community list with the community-list-id is not already present, create a new community list.
void	patch(java.lang.String tier0Id, java.lang.String communityListId, CommunityList communityList, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	If a community list with the community-list-id is not already present, create a new community list.
CommunityList	update(java.lang.String tier0Id, java.lang.String communityListId, CommunityList communityList)	If a community list with the community-list-id is not already present, create a new community list.
void	update(java.lang.String tier0Id, java.lang.String communityListId, CommunityList communityList, com.vmware.vapi.bindings.client.AsyncCallback<CommunityList> asyncCallback)	If a community list with the community-list-id is not already present, create a new community list.
void	update(java.lang.String tier0Id, java.lang.String communityListId, CommunityList communityList, com.vmware.vapi.bindings.client.AsyncCallback<CommunityList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	If a community list with the community-list-id is not already present, create a new community list.
CommunityList	update(java.lang.String tier0Id, java.lang.String communityListId, CommunityList communityList, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	If a community list with the community-list-id is not already present, create a new community list.

Method Detail

delete

void delete(java.lang.String tier0Id,
            java.lang.String communityListId)

Delete a BGP community list

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

Parameters:

tier0Id - (required)

communityListId - (required)

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 tier0Id,
            java.lang.String communityListId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete a BGP community list

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:

tier0Id - (required)

communityListId - (required)

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 tier0Id,
            java.lang.String communityListId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete a BGP community list

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:

tier0Id - (required)

communityListId - (required)

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

delete

void delete(java.lang.String tier0Id,
            java.lang.String communityListId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete a BGP community list

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:

tier0Id - (required)

communityListId - (required)

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

invocationConfig - Configuration for the method invocation.

get

CommunityList get(java.lang.String tier0Id,
                  java.lang.String communityListId)

Read a BGP community list

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

Parameters:

tier0Id - (required)

communityListId - (required)

Returns:

com.vmware.nsx_policy.model.CommunityList

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

CommunityList get(java.lang.String tier0Id,
                  java.lang.String communityListId,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read a BGP community list

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:

tier0Id - (required)

communityListId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.CommunityList

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 tier0Id,
         java.lang.String communityListId,
         com.vmware.vapi.bindings.client.AsyncCallback<CommunityList> asyncCallback)

Read a BGP community list

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

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

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

Parameters:

tier0Id - (required)

communityListId - (required)

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

get

void get(java.lang.String tier0Id,
         java.lang.String communityListId,
         com.vmware.vapi.bindings.client.AsyncCallback<CommunityList> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read a BGP community list

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

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

Parameters:

tier0Id - (required)

communityListId - (required)

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

invocationConfig - Configuration for the method invocation.

list

CommunityListListResult list(java.lang.String tier0Id,
                             java.lang.String cursor,
                             java.lang.Boolean includeMarkForDeleteObjects,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy)

Paginated list of all community lists under a tier-0

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

Parameters:

tier0Id - (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.CommunityListListResult

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

CommunityListListResult list(java.lang.String tier0Id,
                             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)

Paginated list of all community lists under a tier-0

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:

tier0Id - (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.CommunityListListResult

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 tier0Id,
          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<CommunityListListResult> asyncCallback)

Paginated list of all community lists under a tier-0

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

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

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

Parameters:

tier0Id - (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 tier0Id,
          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<CommunityListListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Paginated list of all community lists under a tier-0

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

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

Parameters:

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

patch

void patch(java.lang.String tier0Id,
           java.lang.String communityListId,
           CommunityList communityList)

If a community list with the community-list-id is not already present, create a new community list. If it already exists, update the community list for specified attributes.

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

Parameters:

tier0Id - (required)

communityListId - (required)

communityList - (required)

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

patch

void patch(java.lang.String tier0Id,
           java.lang.String communityListId,
           CommunityList communityList,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a community list with the community-list-id is not already present, create a new community list. If it already exists, update the community list for specified attributes.

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:

tier0Id - (required)

communityListId - (required)

communityList - (required)

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

patch

void patch(java.lang.String tier0Id,
           java.lang.String communityListId,
           CommunityList communityList,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

If a community list with the community-list-id is not already present, create a new community list. If it already exists, update the community list for specified attributes.

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:

tier0Id - (required)

communityListId - (required)

communityList - (required)

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

patch

void patch(java.lang.String tier0Id,
           java.lang.String communityListId,
           CommunityList communityList,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a community list with the community-list-id is not already present, create a new community list. If it already exists, update the community list for specified attributes.

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:

tier0Id - (required)

communityListId - (required)

communityList - (required)

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

invocationConfig - Configuration for the method invocation.

update

CommunityList update(java.lang.String tier0Id,
                     java.lang.String communityListId,
                     CommunityList communityList)

If a community list with the community-list-id is not already present, create a new community list. If it already exists, replace the community list instance with the new object.

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

Parameters:

tier0Id - (required)

communityListId - (required)

communityList - (required)

Returns:

com.vmware.nsx_policy.model.CommunityList

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

CommunityList update(java.lang.String tier0Id,
                     java.lang.String communityListId,
                     CommunityList communityList,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a community list with the community-list-id is not already present, create a new community list. If it already exists, replace the community list instance with the new object.

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:

tier0Id - (required)

communityListId - (required)

communityList - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.CommunityList

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 tier0Id,
            java.lang.String communityListId,
            CommunityList communityList,
            com.vmware.vapi.bindings.client.AsyncCallback<CommunityList> asyncCallback)

If a community list with the community-list-id is not already present, create a new community list. If it already exists, replace the community list instance with the new object.

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

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

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

Parameters:

tier0Id - (required)

communityListId - (required)

communityList - (required)

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

update

void update(java.lang.String tier0Id,
            java.lang.String communityListId,
            CommunityList communityList,
            com.vmware.vapi.bindings.client.AsyncCallback<CommunityList> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

If a community list with the community-list-id is not already present, create a new community list. If it already exists, replace the community list instance with the new object.

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

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

Parameters:

tier0Id - (required)

communityListId - (required)

communityList - (required)

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

invocationConfig - Configuration for the method invocation.