Package com.vmware.nsx_policy.infra.tier_1s

Interface Segments

  • All Superinterfaces:
    SegmentsTypes, com.vmware.vapi.bindings.Service
    All Known Implementing Classes:
    SegmentsStub
    public interface Segments
extends com.vmware.vapi.bindings.Service, SegmentsTypes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete​(java.lang.String tier1Id, java.lang.String segmentId)
      Delete segment
      void delete​(java.lang.String tier1Id, java.lang.String segmentId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Delete segment
      void delete​(java.lang.String tier1Id, java.lang.String segmentId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete segment
      void delete​(java.lang.String tier1Id, java.lang.String segmentId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete segment
      void delete0​(java.lang.String tier1Id, java.lang.String segmentId)
      Force delete bypasses validations during segment deletion.
      void delete0​(java.lang.String tier1Id, java.lang.String segmentId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Force delete bypasses validations during segment deletion.
      void delete0​(java.lang.String tier1Id, java.lang.String segmentId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Force delete bypasses validations during segment deletion.
      void delete0​(java.lang.String tier1Id, java.lang.String segmentId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Force delete bypasses validations during segment deletion.
      void deletedhcpleases​(java.lang.String tier1Id, java.lang.String segmentId, DhcpDeleteLeases dhcpDeleteLeases, java.lang.String enforcementPointPath)
      Delete one or multiple DHCP lease(s) specified by IP and MAC under a Tier-1.
      void deletedhcpleases​(java.lang.String tier1Id, java.lang.String segmentId, DhcpDeleteLeases dhcpDeleteLeases, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Delete one or multiple DHCP lease(s) specified by IP and MAC under a Tier-1.
      void deletedhcpleases​(java.lang.String tier1Id, java.lang.String segmentId, DhcpDeleteLeases dhcpDeleteLeases, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete one or multiple DHCP lease(s) specified by IP and MAC under a Tier-1.
      void deletedhcpleases​(java.lang.String tier1Id, java.lang.String segmentId, DhcpDeleteLeases dhcpDeleteLeases, java.lang.String enforcementPointPath, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete one or multiple DHCP lease(s) specified by IP and MAC under a Tier-1.
      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.
      void patch​(java.lang.String tier1Id, java.lang.String segmentId, Segment segment)
      If segment with the segment-id is not already present, create a new segment.
      void patch​(java.lang.String tier1Id, java.lang.String segmentId, Segment segment, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      If segment with the segment-id is not already present, create a new segment.
      void patch​(java.lang.String tier1Id, java.lang.String segmentId, Segment segment, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If segment with the segment-id is not already present, create a new segment.
      void patch​(java.lang.String tier1Id, java.lang.String segmentId, Segment segment, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If segment with the segment-id is not already present, create a new segment.
      Segment update​(java.lang.String tier1Id, java.lang.String segmentId, Segment segment)
      If segment with the segment-id is not already present, create a new segment.
      void update​(java.lang.String tier1Id, java.lang.String segmentId, Segment segment, com.vmware.vapi.bindings.client.AsyncCallback<Segment> asyncCallback)
      If segment with the segment-id is not already present, create a new segment.
      void update​(java.lang.String tier1Id, java.lang.String segmentId, Segment segment, com.vmware.vapi.bindings.client.AsyncCallback<Segment> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If segment with the segment-id is not already present, create a new segment.
      Segment update​(java.lang.String tier1Id, java.lang.String segmentId, Segment segment, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If segment with the segment-id is not already present, create a new segment.

    • Method Detail

      • delete

        void delete​(java.lang.String tier1Id,
            java.lang.String segmentId)
        Delete segment

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

        Parameters:
        tier1Id - (required)
        segmentId - (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 tier1Id,
            java.lang.String segmentId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete segment

        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)
        segmentId - (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 tier1Id,
            java.lang.String segmentId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Delete segment

        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:
        tier1Id - (required)
        segmentId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • delete

        void delete​(java.lang.String tier1Id,
            java.lang.String segmentId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete segment

        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:
        tier1Id - (required)
        segmentId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • delete0

        void delete0​(java.lang.String tier1Id,
             java.lang.String segmentId)
        Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.

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

        Parameters:
        tier1Id - (required)
        segmentId - (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

      • delete0

        void delete0​(java.lang.String tier1Id,
             java.lang.String segmentId,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.

        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)
        segmentId - (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

      • delete0

        void delete0​(java.lang.String tier1Id,
             java.lang.String segmentId,
             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.

        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:
        tier1Id - (required)
        segmentId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • delete0

        void delete0​(java.lang.String tier1Id,
             java.lang.String segmentId,
             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.

        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:
        tier1Id - (required)
        segmentId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • deletedhcpleases

        void deletedhcpleases​(java.lang.String tier1Id,
                      java.lang.String segmentId,
                      DhcpDeleteLeases dhcpDeleteLeases,
                      java.lang.String enforcementPointPath)
        Delete one or multiple DHCP lease(s) specified by IP and MAC under a Tier-1. If there is a DHCP server running upon the given segment, or this segment is using a DHCP server running in its connected Tier-1, the DHCP lease(s) which match exactly the IP address and the MAC address will be deleted. If no such lease matches, the deletion for this lease will be ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.

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

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        dhcpDeleteLeases - (required)
        enforcementPointPath - Enforcement point path (optional)
        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

      • deletedhcpleases

        void deletedhcpleases​(java.lang.String tier1Id,
                      java.lang.String segmentId,
                      DhcpDeleteLeases dhcpDeleteLeases,
                      java.lang.String enforcementPointPath,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete one or multiple DHCP lease(s) specified by IP and MAC under a Tier-1. If there is a DHCP server running upon the given segment, or this segment is using a DHCP server running in its connected Tier-1, the DHCP lease(s) which match exactly the IP address and the MAC address will be deleted. If no such lease matches, the deletion for this lease will be ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.

        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)
        segmentId - (required)
        dhcpDeleteLeases - (required)
        enforcementPointPath - Enforcement point path (optional)
        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

      • deletedhcpleases

        void deletedhcpleases​(java.lang.String tier1Id,
                      java.lang.String segmentId,
                      DhcpDeleteLeases dhcpDeleteLeases,
                      java.lang.String enforcementPointPath,
                      com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Delete one or multiple DHCP lease(s) specified by IP and MAC under a Tier-1. If there is a DHCP server running upon the given segment, or this segment is using a DHCP server running in its connected Tier-1, the DHCP lease(s) which match exactly the IP address and the MAC address will be deleted. If no such lease matches, the deletion for this lease will be ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.

        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:
        tier1Id - (required)
        segmentId - (required)
        dhcpDeleteLeases - (required)
        enforcementPointPath - Enforcement point path (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • deletedhcpleases

        void deletedhcpleases​(java.lang.String tier1Id,
                      java.lang.String segmentId,
                      DhcpDeleteLeases dhcpDeleteLeases,
                      java.lang.String enforcementPointPath,
                      com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete one or multiple DHCP lease(s) specified by IP and MAC under a Tier-1. If there is a DHCP server running upon the given segment, or this segment is using a DHCP server running in its connected Tier-1, the DHCP lease(s) which match exactly the IP address and the MAC address will be deleted. If no such lease matches, the deletion for this lease will be ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.

        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:
        tier1Id - (required)
        segmentId - (required)
        dhcpDeleteLeases - (required)
        enforcementPointPath - Enforcement point path (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • get

        Segment get​(java.lang.String tier1Id,
            java.lang.String segmentId)
        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.

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        Returns:
        com.vmware.nsx_policy.model.Segment
        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

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

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Segment
        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 segmentId,
         com.vmware.vapi.bindings.client.AsyncCallback<Segment> asyncCallback)
        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

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • get

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

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • list

        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. Result of the invocation will be reported as a method return value.

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

        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. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

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

        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

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

        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.

      • patch

        void patch​(java.lang.String tier1Id,
           java.lang.String segmentId,
           Segment segment)
        If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes. Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the 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 Alarm, GPRR, 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.

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        segment - (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 tier1Id,
           java.lang.String segmentId,
           Segment segment,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes. Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the 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 Alarm, GPRR, 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.

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        segment - (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 tier1Id,
           java.lang.String segmentId,
           Segment segment,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes. Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the 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 Alarm, GPRR, 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.

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

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        segment - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • patch

        void patch​(java.lang.String tier1Id,
           java.lang.String segmentId,
           Segment segment,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes. Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the 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 Alarm, GPRR, 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.

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

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        segment - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • update

        Segment update​(java.lang.String tier1Id,
               java.lang.String segmentId,
               Segment segment)
        If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object. Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the PUT API payload, the path returned in the PUT/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 Alarm, GPRR, 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.

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        segment - (required)
        Returns:
        com.vmware.nsx_policy.model.Segment
        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

        Segment update​(java.lang.String tier1Id,
               java.lang.String segmentId,
               Segment segment,
               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object. Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the PUT API payload, the path returned in the PUT/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 Alarm, GPRR, 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.

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        segment - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Segment
        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 tier1Id,
            java.lang.String segmentId,
            Segment segment,
            com.vmware.vapi.bindings.client.AsyncCallback<Segment> asyncCallback)
        If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object. Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the PUT API payload, the path returned in the PUT/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 Alarm, GPRR, 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

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        segment - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • update

        void update​(java.lang.String tier1Id,
            java.lang.String segmentId,
            Segment segment,
            com.vmware.vapi.bindings.client.AsyncCallback<Segment> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object. Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the \"l2_extension\" object in the PUT API payload, the path returned in the PUT/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 Alarm, GPRR, 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

        Parameters:
        tier1Id - (required)
        segmentId - (required)
        segment - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.