Package com.vmware.nsx_policy.infra.segments

Interface Ports

All Superinterfaces:

PortsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

PortsStub

public interface Ports
extends com.vmware.vapi.bindings.Service, PortsTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.segments.PortsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
void	delete(java.lang.String segmentId, java.lang.String portId)	Delete an infra segment port by giving ID.
void	delete(java.lang.String segmentId, java.lang.String portId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Delete an infra segment port by giving ID.
void	delete(java.lang.String segmentId, java.lang.String portId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete an infra segment port by giving ID.
void	delete(java.lang.String segmentId, java.lang.String portId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete an infra segment port by giving ID.
SegmentPort	get(java.lang.String segmentId, java.lang.String portId)	Get detail information on an infra segment port by giving ID.
void	get(java.lang.String segmentId, java.lang.String portId, com.vmware.vapi.bindings.client.AsyncCallback<SegmentPort> asyncCallback)	Get detail information on an infra segment port by giving ID.
void	get(java.lang.String segmentId, java.lang.String portId, com.vmware.vapi.bindings.client.AsyncCallback<SegmentPort> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get detail information on an infra segment port by giving ID.
SegmentPort	get(java.lang.String segmentId, java.lang.String portId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get detail information on an infra segment port by giving ID.
SegmentPortListResult	list(java.lang.String segmentId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)	List all the ports for an infra.
void	list(java.lang.String segmentId, 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<SegmentPortListResult> asyncCallback)	List all the ports for an infra.
void	list(java.lang.String segmentId, 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<SegmentPortListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	List all the ports for an infra.
SegmentPortListResult	list(java.lang.String segmentId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	List all the ports for an infra.
void	patch(java.lang.String segmentId, java.lang.String portId, SegmentPort segmentPort)	Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.
void	patch(java.lang.String segmentId, java.lang.String portId, SegmentPort segmentPort, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.
void	patch(java.lang.String segmentId, java.lang.String portId, SegmentPort segmentPort, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.
void	patch(java.lang.String segmentId, java.lang.String portId, SegmentPort segmentPort, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.
SegmentPort	update(java.lang.String segmentId, java.lang.String portId, SegmentPort segmentPort)	Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.
void	update(java.lang.String segmentId, java.lang.String portId, SegmentPort segmentPort, com.vmware.vapi.bindings.client.AsyncCallback<SegmentPort> asyncCallback)	Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.
void	update(java.lang.String segmentId, java.lang.String portId, SegmentPort segmentPort, com.vmware.vapi.bindings.client.AsyncCallback<SegmentPort> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.
SegmentPort	update(java.lang.String segmentId, java.lang.String portId, SegmentPort segmentPort, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.

Method Detail

delete

void delete(java.lang.String segmentId,
            java.lang.String portId)

Delete an infra segment port by giving ID. Please note that this operation will not delete the segment port from vCenter Server if the port was connected to a Virtual Machine. Please connect Virtual Machine to another network for the segment port to be deleted from vCenter Server.

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

Parameters:

segmentId - (required)

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

Delete an infra segment port by giving ID. Please note that this operation will not delete the segment port from vCenter Server if the port was connected to a Virtual Machine. Please connect Virtual Machine to another network for the segment port to be deleted from vCenter Server.

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:

segmentId - (required)

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

Delete an infra segment port by giving ID. Please note that this operation will not delete the segment port from vCenter Server if the port was connected to a Virtual Machine. Please connect Virtual Machine to another network for the segment port to be deleted from vCenter Server.

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:

segmentId - (required)

portId - (required)

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

delete

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

Delete an infra segment port by giving ID. Please note that this operation will not delete the segment port from vCenter Server if the port was connected to a Virtual Machine. Please connect Virtual Machine to another network for the segment port to be deleted from vCenter Server.

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:

segmentId - (required)

portId - (required)

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

invocationConfig - Configuration for the method invocation.

get

SegmentPort get(java.lang.String segmentId,
                java.lang.String portId)

Get detail information on an infra segment port by giving ID.

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

Parameters:

segmentId - (required)

portId - (required)

Returns:

com.vmware.nsx_policy.model.SegmentPort

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

SegmentPort get(java.lang.String segmentId,
                java.lang.String portId,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get detail information on an infra segment port by giving ID.

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:

segmentId - (required)

portId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.SegmentPort

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 segmentId,
         java.lang.String portId,
         com.vmware.vapi.bindings.client.AsyncCallback<SegmentPort> asyncCallback)

Get detail information on an infra segment port by giving ID.

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

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

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

Parameters:

segmentId - (required)

portId - (required)

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

get

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

Get detail information on an infra segment port by giving ID.

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

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

Parameters:

segmentId - (required)

portId - (required)

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

invocationConfig - Configuration for the method invocation.

list

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

List all the ports for an infra.

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

Parameters:

segmentId - (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.SegmentPortListResult

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

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

List all the ports for an infra.

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:

segmentId - (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.SegmentPortListResult

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 segmentId,
          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<SegmentPortListResult> asyncCallback)

List all the ports for an infra.

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

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

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

Parameters:

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

List all the ports for an infra.

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

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

Parameters:

segmentId - (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 segmentId,
           java.lang.String portId,
           SegmentPort segmentPort)

Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.

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

Parameters:

segmentId - (required)

portId - (required)

segmentPort - (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 segmentId,
           java.lang.String portId,
           SegmentPort segmentPort,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.

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:

segmentId - (required)

portId - (required)

segmentPort - (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 segmentId,
           java.lang.String portId,
           SegmentPort segmentPort,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.

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:

segmentId - (required)

portId - (required)

segmentPort - (required)

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

patch

void patch(java.lang.String segmentId,
           java.lang.String portId,
           SegmentPort segmentPort,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object fields which presents in the request body.

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:

segmentId - (required)

portId - (required)

segmentPort - (required)

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

invocationConfig - Configuration for the method invocation.

update

SegmentPort update(java.lang.String segmentId,
                   java.lang.String portId,
                   SegmentPort segmentPort)

Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.

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

Parameters:

segmentId - (required)

portId - (required)

segmentPort - (required)

Returns:

com.vmware.nsx_policy.model.SegmentPort

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

SegmentPort update(java.lang.String segmentId,
                   java.lang.String portId,
                   SegmentPort segmentPort,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.

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:

segmentId - (required)

portId - (required)

segmentPort - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.SegmentPort

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 segmentId,
            java.lang.String portId,
            SegmentPort segmentPort,
            com.vmware.vapi.bindings.client.AsyncCallback<SegmentPort> asyncCallback)

Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.

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

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

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

Parameters:

segmentId - (required)

portId - (required)

segmentPort - (required)

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

update

void update(java.lang.String segmentId,
            java.lang.String portId,
            SegmentPort segmentPort,
            com.vmware.vapi.bindings.client.AsyncCallback<SegmentPort> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create an infra segment port if it does not exist based on the IDs, or update existing port information by replacing the port object already exists.

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

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

Parameters:

segmentId - (required)

portId - (required)

segmentPort - (required)

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

invocationConfig - Configuration for the method invocation.