Package com.vmware.nsx_policy.infra.segments

Interface ServiceSegments

All Superinterfaces:

com.vmware.vapi.bindings.Service, ServiceSegmentsTypes

All Known Implementing Classes:

ServiceSegmentsStub

public interface ServiceSegments
extends com.vmware.vapi.bindings.Service, ServiceSegmentsTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.segments.ServiceSegmentsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
void	delete(java.lang.String serviceSegmentId)	Delete Service Segment with given ID
void	delete(java.lang.String serviceSegmentId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	Delete Service Segment with given ID
void	delete(java.lang.String serviceSegmentId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete Service Segment with given ID
void	delete(java.lang.String serviceSegmentId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Delete Service Segment with given ID
ServiceSegment	get(java.lang.String serviceSegmentId)	Read a Service Segment with the given id
void	get(java.lang.String serviceSegmentId, com.vmware.vapi.bindings.client.AsyncCallback<ServiceSegment> asyncCallback)	Read a Service Segment with the given id
void	get(java.lang.String serviceSegmentId, com.vmware.vapi.bindings.client.AsyncCallback<ServiceSegment> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read a Service Segment with the given id
ServiceSegment	get(java.lang.String serviceSegmentId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read a Service Segment with the given id
ServiceSegmentListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)	Paginated list of all Service Segments
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ServiceSegmentListResult> asyncCallback)	Paginated list of all Service Segments
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ServiceSegmentListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Paginated list of all Service Segments
ServiceSegmentListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Paginated list of all Service Segments
void	patch(java.lang.String serviceSegmentId, ServiceSegment serviceSegment)	A service segment with the service-segment-id is created.
void	patch(java.lang.String serviceSegmentId, ServiceSegment serviceSegment, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)	A service segment with the service-segment-id is created.
void	patch(java.lang.String serviceSegmentId, ServiceSegment serviceSegment, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	A service segment with the service-segment-id is created.
void	patch(java.lang.String serviceSegmentId, ServiceSegment serviceSegment, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	A service segment with the service-segment-id is created.
ServiceSegment	update(java.lang.String serviceSegmentId, ServiceSegment serviceSegment)	A service segment with the service-segment-id is created.
void	update(java.lang.String serviceSegmentId, ServiceSegment serviceSegment, com.vmware.vapi.bindings.client.AsyncCallback<ServiceSegment> asyncCallback)	A service segment with the service-segment-id is created.
void	update(java.lang.String serviceSegmentId, ServiceSegment serviceSegment, com.vmware.vapi.bindings.client.AsyncCallback<ServiceSegment> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	A service segment with the service-segment-id is created.
ServiceSegment	update(java.lang.String serviceSegmentId, ServiceSegment serviceSegment, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	A service segment with the service-segment-id is created.

Method Detail

delete

void delete(java.lang.String serviceSegmentId)

Delete Service Segment with given ID

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

Parameters:

serviceSegmentId - Service Segment 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 serviceSegmentId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete Service Segment with given 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:

serviceSegmentId - Service Segment 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 serviceSegmentId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete Service Segment with given 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:

serviceSegmentId - Service Segment ID (required)

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

delete

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

Delete Service Segment with given 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:

serviceSegmentId - Service Segment ID (required)

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

invocationConfig - Configuration for the method invocation.

get

ServiceSegment get(java.lang.String serviceSegmentId)

Read a Service Segment with the given id

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

Parameters:

serviceSegmentId - Service Segment ID (required)

Returns:

com.vmware.nsx_policy.model.ServiceSegment

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

ServiceSegment get(java.lang.String serviceSegmentId,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read a Service Segment with the given 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:

serviceSegmentId - Service Segment ID (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.ServiceSegment

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

Read a Service Segment with the given id

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

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

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

Parameters:

serviceSegmentId - Service Segment ID (required)

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

get

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

Read a Service Segment with the given 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.ServiceSegment

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

Parameters:

serviceSegmentId - Service Segment ID (required)

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

invocationConfig - Configuration for the method invocation.

list

ServiceSegmentListResult list(java.lang.String cursor,
                              java.lang.String includedFields,
                              java.lang.Long pageSize,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy)

Paginated list of all Service Segments

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)

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

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

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

Paginated list of all Service Segments

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)

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

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

Paginated list of all Service Segments

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

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

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)

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

Paginated list of all Service Segments

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

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)

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 serviceSegmentId,
           ServiceSegment serviceSegment)

A service segment with the service-segment-id is created. Modification of service segment is not supported.

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

Parameters:

serviceSegmentId - Service Segment ID (required)

serviceSegment - (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 serviceSegmentId,
           ServiceSegment serviceSegment,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

A service segment with the service-segment-id is created. Modification of service segment is not supported.

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:

serviceSegmentId - Service Segment ID (required)

serviceSegment - (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 serviceSegmentId,
           ServiceSegment serviceSegment,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

A service segment with the service-segment-id is created. Modification of service segment is not supported.

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:

serviceSegmentId - Service Segment ID (required)

serviceSegment - (required)

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

patch

void patch(java.lang.String serviceSegmentId,
           ServiceSegment serviceSegment,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

A service segment with the service-segment-id is created. Modification of service segment is not supported.

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:

serviceSegmentId - Service Segment ID (required)

serviceSegment - (required)

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

invocationConfig - Configuration for the method invocation.

update

ServiceSegment update(java.lang.String serviceSegmentId,
                      ServiceSegment serviceSegment)

A service segment with the service-segment-id is created. Modification of service segment is not supported.

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

Parameters:

serviceSegmentId - Service Segment ID (required)

serviceSegment - (required)

Returns:

com.vmware.nsx_policy.model.ServiceSegment

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

ServiceSegment update(java.lang.String serviceSegmentId,
                      ServiceSegment serviceSegment,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

A service segment with the service-segment-id is created. Modification of service segment is not supported.

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:

serviceSegmentId - Service Segment ID (required)

serviceSegment - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.ServiceSegment

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 serviceSegmentId,
            ServiceSegment serviceSegment,
            com.vmware.vapi.bindings.client.AsyncCallback<ServiceSegment> asyncCallback)

A service segment with the service-segment-id is created. Modification of service segment is not supported.

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

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

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

Parameters:

serviceSegmentId - Service Segment ID (required)

serviceSegment - (required)

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

update

void update(java.lang.String serviceSegmentId,
            ServiceSegment serviceSegment,
            com.vmware.vapi.bindings.client.AsyncCallback<ServiceSegment> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

A service segment with the service-segment-id is created. Modification of service segment is not supported.

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

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

Parameters:

serviceSegmentId - Service Segment ID (required)

serviceSegment - (required)

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

invocationConfig - Configuration for the method invocation.