com.vmware.nsx

Class ClusterProfilesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.ClusterProfilesStub

All Implemented Interfaces:

ClusterProfiles, ClusterProfilesTypes, com.vmware.vapi.bindings.Service

public class ClusterProfilesStub
extends com.vmware.vapi.internal.bindings.Stub
implements ClusterProfiles

Remote stub implementation of the ClusterProfiles 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.ClusterProfilesTypes

_VAPI_SERVICE_ID, LIST_RESOURCE_TYPE_BRIDGEHIGHAVAILABILITYCLUSTERPROFILE, LIST_RESOURCE_TYPE_EDGEHIGHAVAILABILITYPROFILE

Constructor Summary

Constructors

Constructor and Description
ClusterProfilesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
ClusterProfilesStub(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
com.vmware.vapi.bindings.Structure	create(com.vmware.vapi.bindings.Structure clusterProfile) Create a cluster profile.
void	create(com.vmware.vapi.bindings.Structure clusterProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Create a cluster profile.
void	create(com.vmware.vapi.bindings.Structure clusterProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a cluster profile.
com.vmware.vapi.bindings.Structure	create(com.vmware.vapi.bindings.Structure clusterProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create a cluster profile.
void	delete(java.lang.String clusterProfileId) Delete a specified cluster profile.
void	delete(java.lang.String clusterProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete a specified cluster profile.
void	delete(java.lang.String clusterProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a specified cluster profile.
void	delete(java.lang.String clusterProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a specified cluster profile.
com.vmware.vapi.bindings.Structure	get(java.lang.String clusterProfileId) Returns information about a specified cluster profile.
void	get(java.lang.String clusterProfileId, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Returns information about a specified cluster profile.
void	get(java.lang.String clusterProfileId, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specified cluster profile.
com.vmware.vapi.bindings.Structure	get(java.lang.String clusterProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specified cluster profile.
ClusterProfileListResult	list(java.lang.String cursor, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String resourceType, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns paginated list of cluster profiles Cluster profiles define policies for edge cluster and bridge cluster.
void	list(java.lang.String cursor, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String resourceType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ClusterProfileListResult> asyncCallback) Returns paginated list of cluster profiles Cluster profiles define policies for edge cluster and bridge cluster.
void	list(java.lang.String cursor, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String resourceType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ClusterProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns paginated list of cluster profiles Cluster profiles define policies for edge cluster and bridge cluster.
ClusterProfileListResult	list(java.lang.String cursor, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String resourceType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns paginated list of cluster profiles Cluster profiles define policies for edge cluster and bridge cluster.
com.vmware.vapi.bindings.Structure	update(java.lang.String clusterProfileId, com.vmware.vapi.bindings.Structure clusterProfile) Modifie a specified cluster profile.
void	update(java.lang.String clusterProfileId, com.vmware.vapi.bindings.Structure clusterProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Modifie a specified cluster profile.
void	update(java.lang.String clusterProfileId, com.vmware.vapi.bindings.Structure clusterProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifie a specified cluster profile.
com.vmware.vapi.bindings.Structure	update(java.lang.String clusterProfileId, com.vmware.vapi.bindings.Structure clusterProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifie a specified cluster profile.

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

ClusterProfilesStub

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

ClusterProfilesStub

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

Method Detail

create

public com.vmware.vapi.bindings.Structure create(com.vmware.vapi.bindings.Structure clusterProfile)

Description copied from interface: ClusterProfiles

Create a cluster profile. The resource_type is required.

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

Specified by:

create in interface ClusterProfiles

Parameters:

clusterProfile - (required) The parameter must contain all the properties defined in ClusterProfile.

Returns:

com.vmware.nsx.model.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

create

public com.vmware.vapi.bindings.Structure create(com.vmware.vapi.bindings.Structure clusterProfile,
                                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ClusterProfiles

Create a cluster profile. The resource_type is required.

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:

create in interface ClusterProfiles

Parameters:

clusterProfile - (required) The parameter must contain all the properties defined in ClusterProfile.

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

create

public void create(com.vmware.vapi.bindings.Structure clusterProfile,
                   com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback)

Description copied from interface: ClusterProfiles

Create a cluster profile. The resource_type is required.

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

Invocation Result:
com.vmware.nsx.model.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

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

Specified by:

create in interface ClusterProfiles

Parameters:

clusterProfile - (required) The parameter must contain all the properties defined in ClusterProfile.

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

create

public void create(com.vmware.vapi.bindings.Structure clusterProfile,
                   com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ClusterProfiles

Create a cluster profile. The resource_type is required.

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.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

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

Specified by:

create in interface ClusterProfiles

Parameters:

clusterProfile - (required) The parameter must contain all the properties defined in ClusterProfile.

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String clusterProfileId)

Description copied from interface: ClusterProfiles

Delete a specified cluster profile.

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

Specified by:

delete in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

delete

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

Description copied from interface: ClusterProfiles

Delete a specified cluster 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.

Specified by:

delete in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: ClusterProfiles

Delete a specified cluster 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

Specified by:

delete in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

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

delete

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

Description copied from interface: ClusterProfiles

Delete a specified cluster 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

Specified by:

delete in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

get

public com.vmware.vapi.bindings.Structure get(java.lang.String clusterProfileId)

Description copied from interface: ClusterProfiles

Returns information about a specified cluster profile.

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

Specified by:

get in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

Returns:

com.vmware.nsx.model.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

get

public com.vmware.vapi.bindings.Structure get(java.lang.String clusterProfileId,
                                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ClusterProfiles

Returns information about a specified cluster 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.

Specified by:

get in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

get

public void get(java.lang.String clusterProfileId,
                com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback)

Description copied from interface: ClusterProfiles

Returns information about a specified cluster profile.

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

Invocation Result:
com.vmware.nsx.model.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

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

Specified by:

get in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

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

get

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

Description copied from interface: ClusterProfiles

Returns information about a specified cluster 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.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

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

Specified by:

get in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

list

public ClusterProfileListResult list(java.lang.String cursor,
                                     java.lang.Boolean includeSystemOwned,
                                     java.lang.String includedFields,
                                     java.lang.Long pageSize,
                                     java.lang.String resourceType,
                                     java.lang.Boolean sortAscending,
                                     java.lang.String sortBy)

Description copied from interface: ClusterProfiles

Returns paginated list of cluster profiles Cluster profiles define policies for edge cluster and bridge cluster.

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

Specified by:

list in interface ClusterProfiles

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeSystemOwned - Whether the list result contains system resources (optional, default to true)

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)

resourceType - Supported cluster profiles. (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.ClusterProfileListResult

list

public ClusterProfileListResult list(java.lang.String cursor,
                                     java.lang.Boolean includeSystemOwned,
                                     java.lang.String includedFields,
                                     java.lang.Long pageSize,
                                     java.lang.String resourceType,
                                     java.lang.Boolean sortAscending,
                                     java.lang.String sortBy,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ClusterProfiles

Returns paginated list of cluster profiles Cluster profiles define policies for edge cluster and bridge 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.

Specified by:

list in interface ClusterProfiles

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeSystemOwned - Whether the list result contains system resources (optional, default to true)

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)

resourceType - Supported cluster profiles. (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterProfileListResult

list

public void list(java.lang.String cursor,
                 java.lang.Boolean includeSystemOwned,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.String resourceType,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<ClusterProfileListResult> asyncCallback)

Description copied from interface: ClusterProfiles

Returns paginated list of cluster profiles Cluster profiles define policies for edge cluster and bridge cluster.

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

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

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

Specified by:

list in interface ClusterProfiles

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeSystemOwned - Whether the list result contains system resources (optional, default to true)

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)

resourceType - Supported cluster profiles. (optional)

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

Description copied from interface: ClusterProfiles

Returns paginated list of cluster profiles Cluster profiles define policies for edge cluster and bridge 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.ClusterProfileListResult

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

Specified by:

list in interface ClusterProfiles

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeSystemOwned - Whether the list result contains system resources (optional, default to true)

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)

resourceType - Supported cluster profiles. (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.

update

public com.vmware.vapi.bindings.Structure update(java.lang.String clusterProfileId,
                                                 com.vmware.vapi.bindings.Structure clusterProfile)

Description copied from interface: ClusterProfiles

Modifie a specified cluster profile. The body of the PUT request must include the resource_type.

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

Specified by:

update in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

clusterProfile - (required) The parameter must contain all the properties defined in ClusterProfile.

Returns:

com.vmware.nsx.model.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

update

public com.vmware.vapi.bindings.Structure update(java.lang.String clusterProfileId,
                                                 com.vmware.vapi.bindings.Structure clusterProfile,
                                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ClusterProfiles

Modifie a specified cluster profile. The body of the PUT request must include the resource_type.

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 ClusterProfiles

Parameters:

clusterProfileId - (required)

clusterProfile - (required) The parameter must contain all the properties defined in ClusterProfile.

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

update

public void update(java.lang.String clusterProfileId,
                   com.vmware.vapi.bindings.Structure clusterProfile,
                   com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback)

Description copied from interface: ClusterProfiles

Modifie a specified cluster profile. The body of the PUT request must include the resource_type.

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

Invocation Result:
com.vmware.nsx.model.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

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

Specified by:

update in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

clusterProfile - (required) The parameter must contain all the properties defined in ClusterProfile.

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

update

public void update(java.lang.String clusterProfileId,
                   com.vmware.vapi.bindings.Structure clusterProfile,
                   com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: ClusterProfiles

Modifie a specified cluster profile. The body of the PUT request must include the resource_type.

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.ClusterProfile The return value will contain all the properties defined in ClusterProfile.

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

Specified by:

update in interface ClusterProfiles

Parameters:

clusterProfileId - (required)

clusterProfile - (required) The parameter must contain all the properties defined in ClusterProfile.

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

invocationConfig - Configuration for the method invocation.