com.vmware.nsx.fabric

Interface ContainerClusters

All Superinterfaces:

ContainerClustersTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ContainerClustersStub

public interface ContainerClusters
extends com.vmware.vapi.bindings.Service, ContainerClustersTypes

Field Summary

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

_VAPI_SERVICE_ID, LIST_CLUSTER_TYPE_AKS, LIST_CLUSTER_TYPE_EKS, LIST_CLUSTER_TYPE_GARDENER, LIST_CLUSTER_TYPE_GKE, LIST_CLUSTER_TYPE_KUBERNETES, LIST_CLUSTER_TYPE_OPENSHIFT, LIST_CLUSTER_TYPE_OTHER, LIST_CLUSTER_TYPE_PAS, LIST_CLUSTER_TYPE_PKS, LIST_CLUSTER_TYPE_RANCHER, LIST_CLUSTER_TYPE_TAS, LIST_CLUSTER_TYPE_TKGI, LIST_CLUSTER_TYPE_TKGM, LIST_CLUSTER_TYPE_WCP, LIST_CLUSTER_TYPE_WCP_GUEST, LIST_INFRA_TYPE_AWS, LIST_INFRA_TYPE_AZURE, LIST_INFRA_TYPE_BAREMETAL, LIST_INFRA_TYPE_GOOGLE, LIST_INFRA_TYPE_KVM, LIST_INFRA_TYPE_VMC, LIST_INFRA_TYPE_VSPHERE

Method Summary

Modifier and Type	Method and Description
ContainerCluster	get(java.lang.String containerClusterId) Returns information about a specific container cluster
void	get(java.lang.String containerClusterId, com.vmware.vapi.bindings.client.AsyncCallback<ContainerCluster> asyncCallback) Returns information about a specific container cluster
void	get(java.lang.String containerClusterId, com.vmware.vapi.bindings.client.AsyncCallback<ContainerCluster> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specific container cluster
ContainerCluster	get(java.lang.String containerClusterId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specific container cluster
ContainerClusterListResult	list(java.lang.String clusterType, java.lang.String cursor, java.lang.String includedFields, java.lang.String infraType, java.lang.Long pageSize, java.lang.String scopeId, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about all Container Clusters.
void	list(java.lang.String clusterType, java.lang.String cursor, java.lang.String includedFields, java.lang.String infraType, java.lang.Long pageSize, java.lang.String scopeId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ContainerClusterListResult> asyncCallback) Returns information about all Container Clusters.
void	list(java.lang.String clusterType, java.lang.String cursor, java.lang.String includedFields, java.lang.String infraType, java.lang.Long pageSize, java.lang.String scopeId, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ContainerClusterListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all Container Clusters.
ContainerClusterListResult	list(java.lang.String clusterType, java.lang.String cursor, java.lang.String includedFields, java.lang.String infraType, 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 Clusters.

Method Detail

get

ContainerCluster get(java.lang.String containerClusterId)

Returns information about a specific container cluster

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

Parameters:

containerClusterId - (required)

Returns:

com.vmware.nsx.model.ContainerCluster

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

ContainerCluster get(java.lang.String containerClusterId,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specific container cluster

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 - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ContainerCluster

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

Returns information about a specific container cluster

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

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

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

Parameters:

containerClusterId - (required)

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

get

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

Returns information about a specific container cluster

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

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

Parameters:

containerClusterId - (required)

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

invocationConfig - Configuration for the method invocation.

list

ContainerClusterListResult list(java.lang.String clusterType,
                                java.lang.String cursor,
                                java.lang.String includedFields,
                                java.lang.String infraType,
                                java.lang.Long pageSize,
                                java.lang.String scopeId,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy)

Returns information about all Container Clusters.

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

Parameters:

clusterType - Type of 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)

infraType - Type of infrastructure (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.ContainerClusterListResult

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

ContainerClusterListResult list(java.lang.String clusterType,
                                java.lang.String cursor,
                                java.lang.String includedFields,
                                java.lang.String infraType,
                                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 Clusters.

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:

clusterType - Type of 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)

infraType - Type of infrastructure (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.ContainerClusterListResult

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

Returns information about all Container Clusters.

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

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

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

Parameters:

clusterType - Type of 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)

infraType - Type of infrastructure (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 clusterType,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.String infraType,
          java.lang.Long pageSize,
          java.lang.String scopeId,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ContainerClusterListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all Container Clusters.

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

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

Parameters:

clusterType - Type of 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)

infraType - Type of infrastructure (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.