Package com.vmware.nsx_policy.global_infra.tier_1s

Class SegmentsStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx_policy.global_infra.tier_1s.SegmentsStub

All Implemented Interfaces:

Segments, SegmentsTypes, com.vmware.vapi.bindings.Service

public class SegmentsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Segments

Remote stub implementation of the Segments 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_policy.global_infra.tier_1s.SegmentsTypes

_VAPI_SERVICE_ID, LIST_SEGMENT_TYPE_ALL, LIST_SEGMENT_TYPE_DVPORTGROUP

Constructor Summary

Constructors

Constructor	Description
SegmentsStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
SegmentsStub(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	Description
Segment	get(java.lang.String tier1Id, java.lang.String segmentId)	Read segment Note: Extended Segment: Please note that old vpn path deprecated.
void	get(java.lang.String tier1Id, java.lang.String segmentId, com.vmware.vapi.bindings.client.AsyncCallback<Segment> asyncCallback)	Read segment Note: Extended Segment: Please note that old vpn path deprecated.
void	get(java.lang.String tier1Id, java.lang.String segmentId, com.vmware.vapi.bindings.client.AsyncCallback<Segment> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read segment Note: Extended Segment: Please note that old vpn path deprecated.
Segment	get(java.lang.String tier1Id, java.lang.String segmentId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Read segment Note: Extended Segment: Please note that old vpn path deprecated.
SegmentListResult	list(java.lang.String tier1Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentType, java.lang.Boolean sortAscending, java.lang.String sortBy)	Synchronous method overload.
void	list(java.lang.String tier1Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<SegmentListResult> asyncCallback)	Asynchronous method overload.
void	list(java.lang.String tier1Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<SegmentListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Asynchronous method overload.
SegmentListResult	list(java.lang.String tier1Id, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String segmentType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Synchronous method overload.

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

SegmentsStub

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

SegmentsStub

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

Method Detail

get

public Segment get(java.lang.String tier1Id,
                   java.lang.String segmentId)

Description copied from interface: Segments

Read segment Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the PUT/PATCH API payload, the path returned in the GET response payload may include the new path instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact. Also note that l2vpn path included in the error messages returned from validation may include the new VPN path instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.

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

Specified by:

get in interface Segments

Parameters:

tier1Id - (required)

segmentId - (required)

Returns:

com.vmware.nsx_policy.model.Segment

get

public Segment get(java.lang.String tier1Id,
                   java.lang.String segmentId,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Segments

Read segment Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the PUT/PATCH API payload, the path returned in the GET response payload may include the new path instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact. Also note that l2vpn path included in the error messages returned from validation may include the new VPN path instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.

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 Segments

Parameters:

tier1Id - (required)

segmentId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.Segment

get

public void get(java.lang.String tier1Id,
                java.lang.String segmentId,
                com.vmware.vapi.bindings.client.AsyncCallback<Segment> asyncCallback)

Description copied from interface: Segments

Read segment Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the PUT/PATCH API payload, the path returned in the GET response payload may include the new path instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact. Also note that l2vpn path included in the error messages returned from validation may include the new VPN path instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.

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

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

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

Specified by:

get in interface Segments

Parameters:

tier1Id - (required)

segmentId - (required)

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

get

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

Description copied from interface: Segments

Read segment Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the PUT/PATCH API payload, the path returned in the GET response payload may include the new path instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact. Also note that l2vpn path included in the error messages returned from validation may include the new VPN path instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.

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

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

Specified by:

get in interface Segments

Parameters:

tier1Id - (required)

segmentId - (required)

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

invocationConfig - Configuration for the method invocation.

list

public SegmentListResult list(java.lang.String tier1Id,
                              java.lang.String cursor,
                              java.lang.Boolean includeMarkForDeleteObjects,
                              java.lang.String includedFields,
                              java.lang.Long pageSize,
                              java.lang.String segmentType,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy)

Description copied from interface: Segments

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

Specified by:

list in interface Segments

Parameters:

tier1Id - (required)

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)

segmentType - Segment type (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx_policy.model.SegmentListResult

list

public SegmentListResult list(java.lang.String tier1Id,
                              java.lang.String cursor,
                              java.lang.Boolean includeMarkForDeleteObjects,
                              java.lang.String includedFields,
                              java.lang.Long pageSize,
                              java.lang.String segmentType,
                              java.lang.Boolean sortAscending,
                              java.lang.String sortBy,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: 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.

Specified by:

list in interface Segments

Parameters:

tier1Id - (required)

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)

segmentType - Segment type (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.SegmentListResult

list

public void list(java.lang.String tier1Id,
                 java.lang.String cursor,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.String segmentType,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<SegmentListResult> asyncCallback)

Description copied from interface: Segments

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

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

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

Specified by:

list in interface Segments

Parameters:

tier1Id - (required)

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)

segmentType - Segment type (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 tier1Id,
                 java.lang.String cursor,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.String segmentType,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<SegmentListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: 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.SegmentListResult

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

Specified by:

list in interface Segments

Parameters:

tier1Id - (required)

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)

segmentType - Segment type (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.