Package com.vmware.nsx_policy.global_infra.tier_1s.segments

Interface State

All Superinterfaces:

com.vmware.vapi.bindings.Service, StateTypes

All Known Implementing Classes:

StateStub

public interface State
extends com.vmware.vapi.bindings.Service, StateTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.global_infra.tier_1s.segments.StateTypes

_VAPI_SERVICE_ID, GET_BGP_NEIGHBOR_TYPE_INTER_SR, GET_BGP_NEIGHBOR_TYPE_USER, GET_SOURCE_CACHED, GET_SOURCE_REALTIME, GET_STATS_TYPE_STATS, LIST_CONFIGURATION_STATE_FAILED, LIST_CONFIGURATION_STATE_IN_PROGRESS, LIST_CONFIGURATION_STATE_ORPHANED, LIST_CONFIGURATION_STATE_PARTIAL_SUCCESS, LIST_CONFIGURATION_STATE_PENDING, LIST_CONFIGURATION_STATE_SUCCESS, LIST_CONFIGURATION_STATE_UNKNOWN, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME

Method Summary

Modifier and Type	Method	Description
SegmentConfigurationState	get(java.lang.String tier1Id, java.lang.String segmentsId, java.lang.String bgpNeighborType, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String statsType, java.lang.String transportNodeId)	Get tier1 segment state information.
void	get(java.lang.String tier1Id, java.lang.String segmentsId, java.lang.String bgpNeighborType, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String statsType, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<SegmentConfigurationState> asyncCallback)	Get tier1 segment state information.
void	get(java.lang.String tier1Id, java.lang.String segmentsId, java.lang.String bgpNeighborType, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String statsType, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<SegmentConfigurationState> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get tier1 segment state information.
SegmentConfigurationState	get(java.lang.String tier1Id, java.lang.String segmentsId, java.lang.String bgpNeighborType, java.lang.String cursor, java.lang.String edgePath, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String statsType, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get tier1 segment state information.
SegmentConfigurationStateListResult	list(java.lang.String tier1Id, java.lang.String configurationState, java.lang.String enforcementPointPath, java.lang.String source)	Returns all tier-1 segments with configuration state on the enforcement point specified in the request
void	list(java.lang.String tier1Id, java.lang.String configurationState, java.lang.String enforcementPointPath, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<SegmentConfigurationStateListResult> asyncCallback)	Returns all tier-1 segments with configuration state on the enforcement point specified in the request
void	list(java.lang.String tier1Id, java.lang.String configurationState, java.lang.String enforcementPointPath, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<SegmentConfigurationStateListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Returns all tier-1 segments with configuration state on the enforcement point specified in the request
SegmentConfigurationStateListResult	list(java.lang.String tier1Id, java.lang.String configurationState, java.lang.String enforcementPointPath, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Returns all tier-1 segments with configuration state on the enforcement point specified in the request

Method Detail

get

SegmentConfigurationState get(java.lang.String tier1Id,
                              java.lang.String segmentsId,
                              java.lang.String bgpNeighborType,
                              java.lang.String cursor,
                              java.lang.String edgePath,
                              java.lang.String enforcementPointPath,
                              java.lang.Boolean includeMarkForDeleteObjects,
                              java.lang.String includedFields,
                              java.lang.Long pageSize,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy,
                              java.lang.String source,
                              java.lang.String statsType,
                              java.lang.String transportNodeId)

Get tier1 segment state information.

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

Parameters:

tier1Id - (required)

segmentsId - (required)

bgpNeighborType - Bgp neighbor type (optional)

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

edgePath - Policy path of edge node (optional)

enforcementPointPath - String Path of the enforcement point (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)

source - Data source type. (optional)

statsType - Segment statistics type (optional)

transportNodeId - Transport Node Id (optional)

Returns:

com.vmware.nsx_policy.model.SegmentConfigurationState

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

SegmentConfigurationState get(java.lang.String tier1Id,
                              java.lang.String segmentsId,
                              java.lang.String bgpNeighborType,
                              java.lang.String cursor,
                              java.lang.String edgePath,
                              java.lang.String enforcementPointPath,
                              java.lang.Boolean includeMarkForDeleteObjects,
                              java.lang.String includedFields,
                              java.lang.Long pageSize,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy,
                              java.lang.String source,
                              java.lang.String statsType,
                              java.lang.String transportNodeId,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get tier1 segment state information.

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:

tier1Id - (required)

segmentsId - (required)

bgpNeighborType - Bgp neighbor type (optional)

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

edgePath - Policy path of edge node (optional)

enforcementPointPath - String Path of the enforcement point (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)

source - Data source type. (optional)

statsType - Segment statistics type (optional)

transportNodeId - Transport Node Id (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.SegmentConfigurationState

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 tier1Id,
         java.lang.String segmentsId,
         java.lang.String bgpNeighborType,
         java.lang.String cursor,
         java.lang.String edgePath,
         java.lang.String enforcementPointPath,
         java.lang.Boolean includeMarkForDeleteObjects,
         java.lang.String includedFields,
         java.lang.Long pageSize,
         java.lang.Boolean sortAscending,
         java.lang.String sortBy,
         java.lang.String source,
         java.lang.String statsType,
         java.lang.String transportNodeId,
         com.vmware.vapi.bindings.client.AsyncCallback<SegmentConfigurationState> asyncCallback)

Get tier1 segment state information.

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

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

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

Parameters:

tier1Id - (required)

segmentsId - (required)

bgpNeighborType - Bgp neighbor type (optional)

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

edgePath - Policy path of edge node (optional)

enforcementPointPath - String Path of the enforcement point (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)

source - Data source type. (optional)

statsType - Segment statistics type (optional)

transportNodeId - Transport Node Id (optional)

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

get

void get(java.lang.String tier1Id,
         java.lang.String segmentsId,
         java.lang.String bgpNeighborType,
         java.lang.String cursor,
         java.lang.String edgePath,
         java.lang.String enforcementPointPath,
         java.lang.Boolean includeMarkForDeleteObjects,
         java.lang.String includedFields,
         java.lang.Long pageSize,
         java.lang.Boolean sortAscending,
         java.lang.String sortBy,
         java.lang.String source,
         java.lang.String statsType,
         java.lang.String transportNodeId,
         com.vmware.vapi.bindings.client.AsyncCallback<SegmentConfigurationState> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get tier1 segment state information.

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

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

Parameters:

tier1Id - (required)

segmentsId - (required)

bgpNeighborType - Bgp neighbor type (optional)

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

edgePath - Policy path of edge node (optional)

enforcementPointPath - String Path of the enforcement point (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)

source - Data source type. (optional)

statsType - Segment statistics type (optional)

transportNodeId - Transport Node Id (optional)

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

invocationConfig - Configuration for the method invocation.

list

SegmentConfigurationStateListResult list(java.lang.String tier1Id,
                                         java.lang.String configurationState,
                                         java.lang.String enforcementPointPath,
                                         java.lang.String source)

Returns all tier-1 segments with configuration state on the enforcement point specified in the request

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

Parameters:

tier1Id - (required)

configurationState - Configuration state of the segment on enforcement point (optional)

enforcementPointPath - String Path of the enforcement point (optional)

source - Data source type. (optional)

Returns:

com.vmware.nsx_policy.model.SegmentConfigurationStateListResult

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

SegmentConfigurationStateListResult list(java.lang.String tier1Id,
                                         java.lang.String configurationState,
                                         java.lang.String enforcementPointPath,
                                         java.lang.String source,
                                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns all tier-1 segments with configuration state on the enforcement point specified in the request

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:

tier1Id - (required)

configurationState - Configuration state of the segment on enforcement point (optional)

enforcementPointPath - String Path of the enforcement point (optional)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.SegmentConfigurationStateListResult

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 tier1Id,
          java.lang.String configurationState,
          java.lang.String enforcementPointPath,
          java.lang.String source,
          com.vmware.vapi.bindings.client.AsyncCallback<SegmentConfigurationStateListResult> asyncCallback)

Returns all tier-1 segments with configuration state on the enforcement point specified in the request

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

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

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

Parameters:

tier1Id - (required)

configurationState - Configuration state of the segment on enforcement point (optional)

enforcementPointPath - String Path of the enforcement point (optional)

source - Data source type. (optional)

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

list

void list(java.lang.String tier1Id,
          java.lang.String configurationState,
          java.lang.String enforcementPointPath,
          java.lang.String source,
          com.vmware.vapi.bindings.client.AsyncCallback<SegmentConfigurationStateListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns all tier-1 segments with configuration state on the enforcement point specified in the request

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

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

Parameters:

tier1Id - (required)

configurationState - Configuration state of the segment on enforcement point (optional)

enforcementPointPath - String Path of the enforcement point (optional)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.