com.vmware.nsx_policy.infra

Interface ServiceReferences

All Superinterfaces:

com.vmware.vapi.bindings.Service, ServiceReferencesTypes

All Known Implementing Classes:

ServiceReferencesStub

public interface ServiceReferences
extends com.vmware.vapi.bindings.Service, ServiceReferencesTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String serviceReferenceId, java.lang.Boolean cascade) This API can be used to delete a service reference with the given service-reference-id.
void	delete(java.lang.String serviceReferenceId, java.lang.Boolean cascade, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) This API can be used to delete a service reference with the given service-reference-id.
void	delete(java.lang.String serviceReferenceId, java.lang.Boolean cascade, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API can be used to delete a service reference with the given service-reference-id.
void	delete(java.lang.String serviceReferenceId, java.lang.Boolean cascade, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API can be used to delete a service reference with the given service-reference-id.
ServiceReference	get(java.lang.String serviceReferenceId) This API can be used to read service reference with the given service-reference-id.
void	get(java.lang.String serviceReferenceId, com.vmware.vapi.bindings.client.AsyncCallback<ServiceReference> asyncCallback) This API can be used to read service reference with the given service-reference-id.
void	get(java.lang.String serviceReferenceId, com.vmware.vapi.bindings.client.AsyncCallback<ServiceReference> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API can be used to read service reference with the given service-reference-id.
ServiceReference	get(java.lang.String serviceReferenceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API can be used to read service reference with the given service-reference-id.
ServiceReferenceListResult	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 the partner service references available for service insertion
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<ServiceReferenceListResult> asyncCallback) List all the partner service references available for service insertion
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<ServiceReferenceListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List all the partner service references available for service insertion
ServiceReferenceListResult	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 the partner service references available for service insertion
void	patch(java.lang.String serviceReferenceId, ServiceReference serviceReference) Create Service Reference representing the intent to consume a given 3rd party service.
void	patch(java.lang.String serviceReferenceId, ServiceReference serviceReference, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Create Service Reference representing the intent to consume a given 3rd party service.
void	patch(java.lang.String serviceReferenceId, ServiceReference serviceReference, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create Service Reference representing the intent to consume a given 3rd party service.
void	patch(java.lang.String serviceReferenceId, ServiceReference serviceReference, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create Service Reference representing the intent to consume a given 3rd party service.
ServiceReference	update(java.lang.String serviceReferenceId, ServiceReference serviceReference) Create Service Reference representing the intent to consume a given 3rd party service.
void	update(java.lang.String serviceReferenceId, ServiceReference serviceReference, com.vmware.vapi.bindings.client.AsyncCallback<ServiceReference> asyncCallback) Create Service Reference representing the intent to consume a given 3rd party service.
void	update(java.lang.String serviceReferenceId, ServiceReference serviceReference, com.vmware.vapi.bindings.client.AsyncCallback<ServiceReference> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create Service Reference representing the intent to consume a given 3rd party service.
ServiceReference	update(java.lang.String serviceReferenceId, ServiceReference serviceReference, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create Service Reference representing the intent to consume a given 3rd party service.

Method Detail

delete

void delete(java.lang.String serviceReferenceId,
            java.lang.Boolean cascade)

This API can be used to delete a service reference with the given service-reference-id.

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

Parameters:

serviceReferenceId - Id of Service Reference (required)

cascade - Flag to cascade delete all children associated with service reference (optional, default to false)

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 serviceReferenceId,
            java.lang.Boolean cascade,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API can be used to delete a service reference with the given service-reference-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.

Parameters:

serviceReferenceId - Id of Service Reference (required)

cascade - Flag to cascade delete all children associated with service reference (optional, default to false)

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 serviceReferenceId,
            java.lang.Boolean cascade,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

This API can be used to delete a service reference with the given service-reference-id.

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:

serviceReferenceId - Id of Service Reference (required)

cascade - Flag to cascade delete all children associated with service reference (optional, default to false)

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

delete

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

This API can be used to delete a service reference with the given service-reference-id.

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:

serviceReferenceId - Id of Service Reference (required)

cascade - Flag to cascade delete all children associated with service reference (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

get

ServiceReference get(java.lang.String serviceReferenceId)

This API can be used to read service reference with the given service-reference-id.

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

Parameters:

serviceReferenceId - Id of Service Reference (required)

Returns:

com.vmware.nsx_policy.model.ServiceReference

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

ServiceReference get(java.lang.String serviceReferenceId,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API can be used to read service reference with the given service-reference-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.

Parameters:

serviceReferenceId - Id of Service Reference (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.ServiceReference

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

This API can be used to read service reference with the given service-reference-id.

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

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

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

Parameters:

serviceReferenceId - Id of Service Reference (required)

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

get

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

This API can be used to read service reference with the given service-reference-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.ServiceReference

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

Parameters:

serviceReferenceId - Id of Service Reference (required)

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

invocationConfig - Configuration for the method invocation.

list

ServiceReferenceListResult 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 the partner service references available for service insertion

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

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

ServiceReferenceListResult 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 the partner service references available for service insertion

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

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

List all the partner service references available for service insertion

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

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

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

List all the partner service references available for service insertion

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

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 serviceReferenceId,
           ServiceReference serviceReference)

Create Service Reference representing the intent to consume a given 3rd party service.

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

Parameters:

serviceReferenceId - Service reference id (required)

serviceReference - (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 serviceReferenceId,
           ServiceReference serviceReference,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create Service Reference representing the intent to consume a given 3rd party service.

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:

serviceReferenceId - Service reference id (required)

serviceReference - (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 serviceReferenceId,
           ServiceReference serviceReference,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Create Service Reference representing the intent to consume a given 3rd party service.

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:

serviceReferenceId - Service reference id (required)

serviceReference - (required)

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

patch

void patch(java.lang.String serviceReferenceId,
           ServiceReference serviceReference,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create Service Reference representing the intent to consume a given 3rd party service.

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:

serviceReferenceId - Service reference id (required)

serviceReference - (required)

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

invocationConfig - Configuration for the method invocation.

update

ServiceReference update(java.lang.String serviceReferenceId,
                        ServiceReference serviceReference)

Create Service Reference representing the intent to consume a given 3rd party service.

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

Parameters:

serviceReferenceId - Service reference id (required)

serviceReference - (required)

Returns:

com.vmware.nsx_policy.model.ServiceReference

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

ServiceReference update(java.lang.String serviceReferenceId,
                        ServiceReference serviceReference,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create Service Reference representing the intent to consume a given 3rd party service.

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:

serviceReferenceId - Service reference id (required)

serviceReference - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.ServiceReference

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 serviceReferenceId,
            ServiceReference serviceReference,
            com.vmware.vapi.bindings.client.AsyncCallback<ServiceReference> asyncCallback)

Create Service Reference representing the intent to consume a given 3rd party service.

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

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

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

Parameters:

serviceReferenceId - Service reference id (required)

serviceReference - (required)

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

update

void update(java.lang.String serviceReferenceId,
            ServiceReference serviceReference,
            com.vmware.vapi.bindings.client.AsyncCallback<ServiceReference> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Create Service Reference representing the intent to consume a given 3rd party service.

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

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

Parameters:

serviceReferenceId - Service reference id (required)

serviceReference - (required)

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

invocationConfig - Configuration for the method invocation.