com.vmware.nsx_policy.global_infra.segments

Class PortsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx_policy.global_infra.segments.PortsStub

All Implemented Interfaces:

Ports, PortsTypes, com.vmware.vapi.bindings.Service

public class PortsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Ports

Remote stub implementation of the Ports API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

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

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
PortsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
PortsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PortsStub

public PortsStub(com.vmware.vapi.core.ApiProvider apiProvider,
                 com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                 com.vmware.vapi.bindings.StubConfigurationBase config)

PortsStub

public PortsStub(com.vmware.vapi.core.ApiProvider apiProvider,
                 com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

delete

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

Description copied from interface: Ports

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.

Specified by:

delete in interface Ports

Parameters:

segmentId - (required)

portId - (required)

delete

public void delete(java.lang.String segmentId,
                   java.lang.String portId,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Ports

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.

Specified by:

delete in interface Ports

Parameters:

segmentId - (required)

portId - (required)

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: Ports

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

Specified by:

delete in interface Ports

Parameters:

segmentId - (required)

portId - (required)

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

delete

public 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)

Description copied from interface: Ports

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

Specified by:

delete in interface Ports

Parameters:

segmentId - (required)

portId - (required)

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

invocationConfig - Configuration for the method invocation.

get

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

Description copied from interface: Ports

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.

Specified by:

get in interface Ports

Parameters:

segmentId - (required)

portId - (required)

Returns:

com.vmware.nsx_policy.model.SegmentPort

get

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

Description copied from interface: Ports

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.

Specified by:

get in interface Ports

Parameters:

segmentId - (required)

portId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.SegmentPort

get

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

Description copied from interface: Ports

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

Specified by:

get in interface Ports

Parameters:

segmentId - (required)

portId - (required)

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

get

public 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)

Description copied from interface: Ports

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

Specified by:

get in interface Ports

Parameters:

segmentId - (required)

portId - (required)

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

invocationConfig - Configuration for the method invocation.

list

public 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)

Description copied from interface: Ports

List all the ports for an infra.

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

Specified by:

list in interface Ports

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

list

public 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)

Description copied from interface: Ports

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.

Specified by:

list in interface Ports

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

list

public 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)

Description copied from interface: Ports

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

Specified by:

list in interface Ports

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

public 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)

Description copied from interface: Ports

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

Specified by:

list in interface Ports

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

public void patch(java.lang.String segmentId,
                  java.lang.String portId,
                  SegmentPort segmentPort)

Description copied from interface: Ports

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.

Specified by:

patch in interface Ports

Parameters:

segmentId - (required)

portId - (required)

segmentPort - (required)

patch

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

Description copied from interface: Ports

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.

Specified by:

patch in interface Ports

Parameters:

segmentId - (required)

portId - (required)

segmentPort - (required)

invocationConfig - Configuration for the method invocation.

patch

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

Description copied from interface: Ports

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

Specified by:

patch in interface Ports

Parameters:

segmentId - (required)

portId - (required)

segmentPort - (required)

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

patch

public 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)

Description copied from interface: Ports

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

Specified by:

patch in interface Ports

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

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

Description copied from interface: Ports

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.

Specified by:

update in interface Ports

Parameters:

segmentId - (required)

portId - (required)

segmentPort - (required)

Returns:

com.vmware.nsx_policy.model.SegmentPort

update

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

Description copied from interface: Ports

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.

Specified by:

update in interface Ports

Parameters:

segmentId - (required)

portId - (required)

segmentPort - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.SegmentPort

update

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

Description copied from interface: Ports

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

Specified by:

update in interface Ports

Parameters:

segmentId - (required)

portId - (required)

segmentPort - (required)

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

update

public 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)

Description copied from interface: Ports

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

Specified by:

update in interface Ports

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.