com.vmware.nsx.dhcp

Interface Relays

All Superinterfaces:

RelaysTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RelaysStub

public interface Relays
extends com.vmware.vapi.bindings.Service, RelaysTypes

Field Summary

Fields inherited from interface com.vmware.nsx.dhcp.RelaysTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
DhcpRelayService	create(DhcpRelayService dhcpRelayService) Deprecated.
void	create(DhcpRelayService dhcpRelayService, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback) Deprecated.
void	create(DhcpRelayService dhcpRelayService, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayService	create(DhcpRelayService dhcpRelayService, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String relayId) Deprecated.
void	delete(java.lang.String relayId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String relayId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String relayId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayService	get(java.lang.String relayId) Deprecated.
void	get(java.lang.String relayId, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback) Deprecated.
void	get(java.lang.String relayId, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayService	get(java.lang.String relayId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayServiceListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Deprecated.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayServiceListResult> asyncCallback) Deprecated.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayServiceListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayServiceListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayService	update(java.lang.String relayId, DhcpRelayService dhcpRelayService) Deprecated.
void	update(java.lang.String relayId, DhcpRelayService dhcpRelayService, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback) Deprecated.
void	update(java.lang.String relayId, DhcpRelayService dhcpRelayService, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayService	update(java.lang.String relayId, DhcpRelayService dhcpRelayService, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
DhcpRelayService create(DhcpRelayService dhcpRelayService)

Deprecated.

Creates a dhcp relay service.

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

Parameters:

dhcpRelayService - (required)

Returns:

com.vmware.nsx.model.DhcpRelayService

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

@Deprecated
DhcpRelayService create(DhcpRelayService dhcpRelayService,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Creates a dhcp relay service.

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:

dhcpRelayService - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpRelayService

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

@Deprecated
void create(DhcpRelayService dhcpRelayService,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback)

Deprecated.

Creates a dhcp relay service.

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

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

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

Parameters:

dhcpRelayService - (required)

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

create

@Deprecated
void create(DhcpRelayService dhcpRelayService,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Creates a dhcp relay service.

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

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

Parameters:

dhcpRelayService - (required)

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

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String relayId)

Deprecated.

Deletes the specified dhcp relay service.

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

Parameters:

relayId - (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

@Deprecated
void delete(java.lang.String relayId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Deletes the specified dhcp relay service.

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:

relayId - (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

@Deprecated
void delete(java.lang.String relayId,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

Deletes the specified dhcp relay service.

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:

relayId - (required)

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

delete

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

Deprecated.

Deletes the specified dhcp relay service.

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:

relayId - (required)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
DhcpRelayService get(java.lang.String relayId)

Deprecated.

Returns the dhcp relay service information.

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

Parameters:

relayId - (required)

Returns:

com.vmware.nsx.model.DhcpRelayService

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

@Deprecated
DhcpRelayService get(java.lang.String relayId,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns the dhcp relay service information.

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:

relayId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpRelayService

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

@Deprecated
void get(java.lang.String relayId,
                     com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback)

Deprecated.

Returns the dhcp relay service information.

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

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

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

Parameters:

relayId - (required)

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

get

@Deprecated
void get(java.lang.String relayId,
                     com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns the dhcp relay service information.

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

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

Parameters:

relayId - (required)

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

invocationConfig - Configuration for the method invocation.

list

@Deprecated
DhcpRelayServiceListResult list(java.lang.String cursor,
                                            java.lang.String includedFields,
                                            java.lang.Long pageSize,
                                            java.lang.Boolean sortAscending,
                                            java.lang.String sortBy)

Deprecated.

Returns information about all configured dhcp relay services.

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)

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

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

@Deprecated
DhcpRelayServiceListResult list(java.lang.String cursor,
                                            java.lang.String includedFields,
                                            java.lang.Long pageSize,
                                            java.lang.Boolean sortAscending,
                                            java.lang.String sortBy,
                                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about all configured dhcp relay services.

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)

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

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

@Deprecated
void list(java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayServiceListResult> asyncCallback)

Deprecated.

Returns information about all configured dhcp relay services.

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

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

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)

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

@Deprecated
void list(java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayServiceListResult> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about all configured dhcp relay services.

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

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)

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

@Deprecated
DhcpRelayService update(java.lang.String relayId,
                                    DhcpRelayService dhcpRelayService)

Deprecated.

Modifies the specified dhcp relay service.

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

Parameters:

relayId - (required)

dhcpRelayService - (required)

Returns:

com.vmware.nsx.model.DhcpRelayService

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

@Deprecated
DhcpRelayService update(java.lang.String relayId,
                                    DhcpRelayService dhcpRelayService,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies the specified dhcp relay service.

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:

relayId - (required)

dhcpRelayService - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpRelayService

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

@Deprecated
void update(java.lang.String relayId,
                        DhcpRelayService dhcpRelayService,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback)

Deprecated.

Modifies the specified dhcp relay service.

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

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

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

Parameters:

relayId - (required)

dhcpRelayService - (required)

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

update

@Deprecated
void update(java.lang.String relayId,
                        DhcpRelayService dhcpRelayService,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayService> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies the specified dhcp relay service.

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

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

Parameters:

relayId - (required)

dhcpRelayService - (required)

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

invocationConfig - Configuration for the method invocation.