com.vmware.nsx.dhcp

Interface RelayProfiles

All Superinterfaces:

RelayProfilesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RelayProfilesStub

public interface RelayProfiles
extends com.vmware.vapi.bindings.Service, RelayProfilesTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
DhcpRelayProfile	create(DhcpRelayProfile dhcpRelayProfile) Deprecated.
void	create(DhcpRelayProfile dhcpRelayProfile, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayProfile> asyncCallback) Deprecated.
void	create(DhcpRelayProfile dhcpRelayProfile, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayProfile	create(DhcpRelayProfile dhcpRelayProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String relayProfileId) Deprecated.
void	delete(java.lang.String relayProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String relayProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String relayProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayProfile	get(java.lang.String relayProfileId) Deprecated.
void	get(java.lang.String relayProfileId, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayProfile> asyncCallback) Deprecated.
void	get(java.lang.String relayProfileId, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayProfile	get(java.lang.String relayProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayProfileListResult	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<DhcpRelayProfileListResult> 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<DhcpRelayProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayProfileListResult	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.
DhcpRelayProfile	update(java.lang.String relayProfileId, DhcpRelayProfile dhcpRelayProfile) Deprecated.
void	update(java.lang.String relayProfileId, DhcpRelayProfile dhcpRelayProfile, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayProfile> asyncCallback) Deprecated.
void	update(java.lang.String relayProfileId, DhcpRelayProfile dhcpRelayProfile, com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpRelayProfile	update(java.lang.String relayProfileId, DhcpRelayProfile dhcpRelayProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
DhcpRelayProfile create(DhcpRelayProfile dhcpRelayProfile)

Deprecated.

Creates a dhcp relay profile.

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

Parameters:

dhcpRelayProfile - (required)

Returns:

com.vmware.nsx.model.DhcpRelayProfile

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

Deprecated.

Creates a dhcp relay 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:

dhcpRelayProfile - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpRelayProfile

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(DhcpRelayProfile dhcpRelayProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayProfile> asyncCallback)

Deprecated.

Creates a dhcp relay profile.

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

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

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

Parameters:

dhcpRelayProfile - (required)

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

create

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

Deprecated.

Creates a dhcp relay 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.DhcpRelayProfile

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

Parameters:

dhcpRelayProfile - (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 relayProfileId)

Deprecated.

Deletes the specified dhcp relay profile.

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

Parameters:

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

Deprecated.

Deletes the specified dhcp relay 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:

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

Deprecated.

Deletes the specified dhcp relay 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:

relayProfileId - (required)

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

delete

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

Deprecated.

Deletes the specified dhcp relay 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:

relayProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
DhcpRelayProfile get(java.lang.String relayProfileId)

Deprecated.

Returns information about the specified dhcp relay profile.

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

Parameters:

relayProfileId - (required)

Returns:

com.vmware.nsx.model.DhcpRelayProfile

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
DhcpRelayProfile get(java.lang.String relayProfileId,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about the specified dhcp relay 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:

relayProfileId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpRelayProfile

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

Deprecated.

Returns information about the specified dhcp relay profile.

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

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

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

Parameters:

relayProfileId - (required)

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

get

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

Deprecated.

Returns information about the specified dhcp relay 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.DhcpRelayProfile

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

Parameters:

relayProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

list

@Deprecated
DhcpRelayProfileListResult 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 dhcp relay 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)

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

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
DhcpRelayProfileListResult 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 dhcp relay 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)

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

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<DhcpRelayProfileListResult> asyncCallback)

Deprecated.

Returns information about all dhcp relay profiles.

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

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

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

Deprecated.

Returns information about all dhcp relay 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.DhcpRelayProfileListResult

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
DhcpRelayProfile update(java.lang.String relayProfileId,
                                    DhcpRelayProfile dhcpRelayProfile)

Deprecated.

Modifies the specified dhcp relay profile.

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

Parameters:

relayProfileId - (required)

dhcpRelayProfile - (required)

Returns:

com.vmware.nsx.model.DhcpRelayProfile

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
DhcpRelayProfile update(java.lang.String relayProfileId,
                                    DhcpRelayProfile dhcpRelayProfile,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies the specified dhcp relay 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:

relayProfileId - (required)

dhcpRelayProfile - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpRelayProfile

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 relayProfileId,
                        DhcpRelayProfile dhcpRelayProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayProfile> asyncCallback)

Deprecated.

Modifies the specified dhcp relay profile.

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

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

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

Parameters:

relayProfileId - (required)

dhcpRelayProfile - (required)

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

update

@Deprecated
void update(java.lang.String relayProfileId,
                        DhcpRelayProfile dhcpRelayProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpRelayProfile> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies the specified dhcp relay 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.DhcpRelayProfile

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

Parameters:

relayProfileId - (required)

dhcpRelayProfile - (required)

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

invocationConfig - Configuration for the method invocation.