com.vmware.nsx

Interface BridgeEndpointProfiles

All Superinterfaces:

BridgeEndpointProfilesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

BridgeEndpointProfilesStub

public interface BridgeEndpointProfiles
extends com.vmware.vapi.bindings.Service, BridgeEndpointProfilesTypes

Field Summary

Fields inherited from interface com.vmware.nsx.BridgeEndpointProfilesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
BridgeEndpointProfile	create(BridgeEndpointProfile bridgeEndpointProfile) Creates a Bridge Endpoint Profile.
void	create(BridgeEndpointProfile bridgeEndpointProfile, com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback) Creates a Bridge Endpoint Profile.
void	create(BridgeEndpointProfile bridgeEndpointProfile, com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a Bridge Endpoint Profile.
BridgeEndpointProfile	create(BridgeEndpointProfile bridgeEndpointProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a Bridge Endpoint Profile.
void	delete(java.lang.String bridgeendpointprofileId) Deletes the specified Bridge Endpoint Profile.
void	delete(java.lang.String bridgeendpointprofileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deletes the specified Bridge Endpoint Profile.
void	delete(java.lang.String bridgeendpointprofileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes the specified Bridge Endpoint Profile.
void	delete(java.lang.String bridgeendpointprofileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes the specified Bridge Endpoint Profile.
BridgeEndpointProfile	get(java.lang.String bridgeendpointprofileId) Returns information about a specified bridge endpoint profile.
void	get(java.lang.String bridgeendpointprofileId, com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback) Returns information about a specified bridge endpoint profile.
void	get(java.lang.String bridgeendpointprofileId, com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specified bridge endpoint profile.
BridgeEndpointProfile	get(java.lang.String bridgeendpointprofileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specified bridge endpoint profile.
BridgeEndpointProfileListResult	list(java.lang.String cursor, java.lang.String edgeClusterId, java.lang.String failoverMode, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about all configured bridge endoint profiles
void	list(java.lang.String cursor, java.lang.String edgeClusterId, java.lang.String failoverMode, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfileListResult> asyncCallback) Returns information about all configured bridge endoint profiles
void	list(java.lang.String cursor, java.lang.String edgeClusterId, java.lang.String failoverMode, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all configured bridge endoint profiles
BridgeEndpointProfileListResult	list(java.lang.String cursor, java.lang.String edgeClusterId, java.lang.String failoverMode, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all configured bridge endoint profiles
BridgeEndpointProfile	update(java.lang.String bridgeendpointprofileId, BridgeEndpointProfile bridgeEndpointProfile) Modifies a existing bridge endpoint profile.
void	update(java.lang.String bridgeendpointprofileId, BridgeEndpointProfile bridgeEndpointProfile, com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback) Modifies a existing bridge endpoint profile.
void	update(java.lang.String bridgeendpointprofileId, BridgeEndpointProfile bridgeEndpointProfile, com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies a existing bridge endpoint profile.
BridgeEndpointProfile	update(java.lang.String bridgeendpointprofileId, BridgeEndpointProfile bridgeEndpointProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies a existing bridge endpoint profile.

Method Detail

create

BridgeEndpointProfile create(BridgeEndpointProfile bridgeEndpointProfile)

Creates a Bridge Endpoint Profile. Profile contains edge cluster id, indexes of the member nodes, fialover mode and high availability mode for a Bridge EndPoint

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

Parameters:

bridgeEndpointProfile - (required)

Returns:

com.vmware.nsx.model.BridgeEndpointProfile

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

create

BridgeEndpointProfile create(BridgeEndpointProfile bridgeEndpointProfile,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Creates a Bridge Endpoint Profile. Profile contains edge cluster id, indexes of the member nodes, fialover mode and high availability mode for a Bridge EndPoint

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:

bridgeEndpointProfile - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BridgeEndpointProfile

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

create

void create(BridgeEndpointProfile bridgeEndpointProfile,
            com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback)

Creates a Bridge Endpoint Profile. Profile contains edge cluster id, indexes of the member nodes, fialover mode and high availability mode for a Bridge EndPoint

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

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

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

Parameters:

bridgeEndpointProfile - (required)

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

create

void create(BridgeEndpointProfile bridgeEndpointProfile,
            com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Creates a Bridge Endpoint Profile. Profile contains edge cluster id, indexes of the member nodes, fialover mode and high availability mode for a Bridge EndPoint

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

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

Parameters:

bridgeEndpointProfile - (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String bridgeendpointprofileId)

Deletes the specified Bridge Endpoint Profile.

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

Parameters:

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

Deletes the specified Bridge Endpoint Profile.

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:

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

Deletes the specified Bridge Endpoint Profile.

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:

bridgeendpointprofileId - (required)

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

delete

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

Deletes the specified Bridge Endpoint Profile.

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:

bridgeendpointprofileId - (required)

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

invocationConfig - Configuration for the method invocation.

get

BridgeEndpointProfile get(java.lang.String bridgeendpointprofileId)

Returns information about a specified bridge endpoint profile.

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

Parameters:

bridgeendpointprofileId - (required)

Returns:

com.vmware.nsx.model.BridgeEndpointProfile

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

BridgeEndpointProfile get(java.lang.String bridgeendpointprofileId,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specified bridge endpoint profile.

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:

bridgeendpointprofileId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BridgeEndpointProfile

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 bridgeendpointprofileId,
         com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback)

Returns information about a specified bridge endpoint profile.

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

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

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

Parameters:

bridgeendpointprofileId - (required)

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

get

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

Returns information about a specified bridge endpoint profile.

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

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

Parameters:

bridgeendpointprofileId - (required)

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

invocationConfig - Configuration for the method invocation.

list

BridgeEndpointProfileListResult list(java.lang.String cursor,
                                     java.lang.String edgeClusterId,
                                     java.lang.String failoverMode,
                                     java.lang.String includedFields,
                                     java.lang.Long pageSize,
                                     java.lang.Boolean sortAscending,
                                     java.lang.String sortBy)

Returns information about all configured bridge endoint profiles

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

Parameters:

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

edgeClusterId - Edge Cluster Identifier (optional)

failoverMode - (optional)

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.model.BridgeEndpointProfileListResult

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

BridgeEndpointProfileListResult list(java.lang.String cursor,
                                     java.lang.String edgeClusterId,
                                     java.lang.String failoverMode,
                                     java.lang.String includedFields,
                                     java.lang.Long pageSize,
                                     java.lang.Boolean sortAscending,
                                     java.lang.String sortBy,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all configured bridge endoint profiles

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:

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

edgeClusterId - Edge Cluster Identifier (optional)

failoverMode - (optional)

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.model.BridgeEndpointProfileListResult

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 cursor,
          java.lang.String edgeClusterId,
          java.lang.String failoverMode,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfileListResult> asyncCallback)

Returns information about all configured bridge endoint profiles

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

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

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

Parameters:

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

edgeClusterId - Edge Cluster Identifier (optional)

failoverMode - (optional)

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 cursor,
          java.lang.String edgeClusterId,
          java.lang.String failoverMode,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfileListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all configured bridge endoint profiles

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

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

Parameters:

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

edgeClusterId - Edge Cluster Identifier (optional)

failoverMode - (optional)

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

BridgeEndpointProfile update(java.lang.String bridgeendpointprofileId,
                             BridgeEndpointProfile bridgeEndpointProfile)

Modifies a existing bridge endpoint profile.

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

Parameters:

bridgeendpointprofileId - (required)

bridgeEndpointProfile - (required)

Returns:

com.vmware.nsx.model.BridgeEndpointProfile

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

BridgeEndpointProfile update(java.lang.String bridgeendpointprofileId,
                             BridgeEndpointProfile bridgeEndpointProfile,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Modifies a existing bridge endpoint profile.

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:

bridgeendpointprofileId - (required)

bridgeEndpointProfile - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BridgeEndpointProfile

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 bridgeendpointprofileId,
            BridgeEndpointProfile bridgeEndpointProfile,
            com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback)

Modifies a existing bridge endpoint profile.

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

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

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

Parameters:

bridgeendpointprofileId - (required)

bridgeEndpointProfile - (required)

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

update

void update(java.lang.String bridgeendpointprofileId,
            BridgeEndpointProfile bridgeEndpointProfile,
            com.vmware.vapi.bindings.client.AsyncCallback<BridgeEndpointProfile> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Modifies a existing bridge endpoint profile.

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

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

Parameters:

bridgeendpointprofileId - (required)

bridgeEndpointProfile - (required)

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

invocationConfig - Configuration for the method invocation.