com.vmware.nsx.fabric

Interface ContainerIpPools

All Superinterfaces:

ContainerIpPoolsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ContainerIpPoolsStub

public interface ContainerIpPools
extends com.vmware.vapi.bindings.Service, ContainerIpPoolsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.fabric.ContainerIpPoolsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ContainerIpPoolListResult	list(java.lang.String containerClusterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scopeId, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about all container ip pools.
void	list(java.lang.String containerClusterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scopeId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ContainerIpPoolListResult> asyncCallback) Returns information about all container ip pools.
void	list(java.lang.String containerClusterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scopeId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ContainerIpPoolListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all container ip pools.
ContainerIpPoolListResult	list(java.lang.String containerClusterId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scopeId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all container ip pools.

Method Detail

list

ContainerIpPoolListResult list(java.lang.String containerClusterId,
                               java.lang.String cursor,
                               java.lang.String includedFields,
                               java.lang.Long pageSize,
                               java.lang.String scopeId,
                               java.lang.Boolean sortAscending,
                               java.lang.String sortBy)

Returns information about all container ip pools.

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

Parameters:

containerClusterId - Identifier of the container cluster (optional)

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)

scopeId - Scope id for container cluster (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.ContainerIpPoolListResult

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

ContainerIpPoolListResult list(java.lang.String containerClusterId,
                               java.lang.String cursor,
                               java.lang.String includedFields,
                               java.lang.Long pageSize,
                               java.lang.String scopeId,
                               java.lang.Boolean sortAscending,
                               java.lang.String sortBy,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all container ip pools.

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:

containerClusterId - Identifier of the container cluster (optional)

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)

scopeId - Scope id for container cluster (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ContainerIpPoolListResult

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

Returns information about all container ip pools.

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

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

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

Parameters:

containerClusterId - Identifier of the container cluster (optional)

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)

scopeId - Scope id for container cluster (optional)

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

Returns information about all container ip pools.

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

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

Parameters:

containerClusterId - Identifier of the container cluster (optional)

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)

scopeId - Scope id for container cluster (optional)

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.