Package com.vmware.nsx_policy.infra

Interface PimProfiles

All Superinterfaces:

PimProfilesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

PimProfilesStub

public interface PimProfiles
extends com.vmware.vapi.bindings.Service, PimProfilesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.PimProfilesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
void	delete(java.lang.String pimProfileId)	Delete Pim Profile.
void	delete(java.lang.String pimProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Delete Pim Profile.
void	delete(java.lang.String pimProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete Pim Profile.
void	delete(java.lang.String pimProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete Pim Profile.
PolicyPimProfile	get(java.lang.String pimProfileId)	Read Pim Profile.
void	get(java.lang.String pimProfileId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyPimProfile> asyncCallback)	Read Pim Profile.
void	get(java.lang.String pimProfileId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyPimProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read Pim Profile.
PolicyPimProfile	get(java.lang.String pimProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read Pim Profile.
PolicyPimProfileListResult	list(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 pim profile.
void	list(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<PolicyPimProfileListResult> asyncCallback)	List all pim profile.
void	list(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<PolicyPimProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	List all pim profile.
PolicyPimProfileListResult	list(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 pim profile.
void	patch(java.lang.String pimProfileId, PolicyPimProfile policyPimProfile)	Create a pim profile with the pim-profile-id is not already present, otherwise update the pim profile.
void	patch(java.lang.String pimProfileId, PolicyPimProfile policyPimProfile, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Create a pim profile with the pim-profile-id is not already present, otherwise update the pim profile.
void	patch(java.lang.String pimProfileId, PolicyPimProfile policyPimProfile, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create a pim profile with the pim-profile-id is not already present, otherwise update the pim profile.
void	patch(java.lang.String pimProfileId, PolicyPimProfile policyPimProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create a pim profile with the pim-profile-id is not already present, otherwise update the pim profile.
PolicyPimProfile	update(java.lang.String pimProfileId, PolicyPimProfile policyPimProfile)	Create or update pim profile.
void	update(java.lang.String pimProfileId, PolicyPimProfile policyPimProfile, com.vmware.vapi.bindings.client.AsyncCallback<PolicyPimProfile> asyncCallback)	Create or update pim profile.
void	update(java.lang.String pimProfileId, PolicyPimProfile policyPimProfile, com.vmware.vapi.bindings.client.AsyncCallback<PolicyPimProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create or update pim profile.
PolicyPimProfile	update(java.lang.String pimProfileId, PolicyPimProfile policyPimProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Create or update pim profile.

Method Detail

delete

void delete(java.lang.String pimProfileId)

Delete Pim Profile.

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

Parameters:

pimProfileId - pim profile id (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 pimProfileId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete Pim 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.

Parameters:

pimProfileId - pim profile id (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 pimProfileId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete Pim 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

Parameters:

pimProfileId - pim profile id (required)

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

delete

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

Delete Pim 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

Parameters:

pimProfileId - pim profile id (required)

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

invocationConfig - Configuration for the method invocation.

get

PolicyPimProfile get(java.lang.String pimProfileId)

Read Pim Profile.

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

Parameters:

pimProfileId - pim profile id (required)

Returns:

com.vmware.nsx_policy.model.PolicyPimProfile

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

PolicyPimProfile get(java.lang.String pimProfileId,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read Pim 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.

Parameters:

pimProfileId - pim profile id (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyPimProfile

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

Read Pim Profile.

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

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

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

Parameters:

pimProfileId - pim profile id (required)

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

get

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

Read Pim 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_policy.model.PolicyPimProfile

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

Parameters:

pimProfileId - pim profile id (required)

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

invocationConfig - Configuration for the method invocation.

list

PolicyPimProfileListResult list(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 pim profile.

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

Parameters:

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

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

PolicyPimProfileListResult list(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 pim 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.

Parameters:

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

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 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<PolicyPimProfileListResult> asyncCallback)

List all pim profile.

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

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

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

Parameters:

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

List all pim 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_policy.model.PolicyPimProfileListResult

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

Parameters:

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 pimProfileId,
           PolicyPimProfile policyPimProfile)

Create a pim profile with the pim-profile-id is not already present, otherwise update the pim profile.

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

Parameters:

pimProfileId - pim profile id (required)

policyPimProfile - (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 pimProfileId,
           PolicyPimProfile policyPimProfile,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a pim profile with the pim-profile-id is not already present, otherwise update the pim 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.

Parameters:

pimProfileId - pim profile id (required)

policyPimProfile - (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 pimProfileId,
           PolicyPimProfile policyPimProfile,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Create a pim profile with the pim-profile-id is not already present, otherwise update the pim 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

Parameters:

pimProfileId - pim profile id (required)

policyPimProfile - (required)

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

patch

void patch(java.lang.String pimProfileId,
           PolicyPimProfile policyPimProfile,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create a pim profile with the pim-profile-id is not already present, otherwise update the pim 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

Parameters:

pimProfileId - pim profile id (required)

policyPimProfile - (required)

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

invocationConfig - Configuration for the method invocation.

update

PolicyPimProfile update(java.lang.String pimProfileId,
                        PolicyPimProfile policyPimProfile)

Create or update pim profile.

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

Parameters:

pimProfileId - pim profile id (required)

policyPimProfile - (required)

Returns:

com.vmware.nsx_policy.model.PolicyPimProfile

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

PolicyPimProfile update(java.lang.String pimProfileId,
                        PolicyPimProfile policyPimProfile,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create or update pim 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.

Parameters:

pimProfileId - pim profile id (required)

policyPimProfile - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyPimProfile

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 pimProfileId,
            PolicyPimProfile policyPimProfile,
            com.vmware.vapi.bindings.client.AsyncCallback<PolicyPimProfile> asyncCallback)

Create or update pim profile.

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

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

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

Parameters:

pimProfileId - pim profile id (required)

policyPimProfile - (required)

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

update

void update(java.lang.String pimProfileId,
            PolicyPimProfile policyPimProfile,
            com.vmware.vapi.bindings.client.AsyncCallback<PolicyPimProfile> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create or update pim 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_policy.model.PolicyPimProfile

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

Parameters:

pimProfileId - pim profile id (required)

policyPimProfile - (required)

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

invocationConfig - Configuration for the method invocation.