Package com.vmware.nsx_policy.infra

Interface Shares

  • All Superinterfaces:
    com.vmware.vapi.bindings.Service, SharesTypes
    All Known Implementing Classes:
    SharesStub
    public interface Shares
extends com.vmware.vapi.bindings.Service, SharesTypes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete​(java.lang.String shareId)
      Delete a Share.
      void delete​(java.lang.String shareId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Delete a Share.
      void delete​(java.lang.String shareId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete a Share.
      void delete​(java.lang.String shareId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete a Share.
      Share get​(java.lang.String shareId)
      Get single instance of a share
      void get​(java.lang.String shareId, com.vmware.vapi.bindings.client.AsyncCallback<Share> asyncCallback)
      Get single instance of a share
      void get​(java.lang.String shareId, com.vmware.vapi.bindings.client.AsyncCallback<Share> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Get single instance of a share
      Share get​(java.lang.String shareId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Get single instance of a share
      ShareListResult list​(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)
      List shares
      void list​(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ShareListResult> asyncCallback)
      List shares
      void list​(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ShareListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      List shares
      ShareListResult list​(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      List shares
      void patch​(java.lang.String shareId, Share share)
      If a Share with the given ID already exists, update the share entity.
      void patch​(java.lang.String shareId, Share share, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      If a Share with the given ID already exists, update the share entity.
      void patch​(java.lang.String shareId, Share share, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If a Share with the given ID already exists, update the share entity.
      void patch​(java.lang.String shareId, Share share, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If a Share with the given ID already exists, update the share entity.
      Share update​(java.lang.String shareId, Share share)
      If a Share with the given ID already exists, and the revision is 0, throw error
      void update​(java.lang.String shareId, Share share, com.vmware.vapi.bindings.client.AsyncCallback<Share> asyncCallback)
      If a Share with the given ID already exists, and the revision is 0, throw error
      void update​(java.lang.String shareId, Share share, com.vmware.vapi.bindings.client.AsyncCallback<Share> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If a Share with the given ID already exists, and the revision is 0, throw error
      Share update​(java.lang.String shareId, Share share, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If a Share with the given ID already exists, and the revision is 0, throw error

    • Method Detail

      • delete

        void delete​(java.lang.String shareId)
        Delete a Share.

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

        Parameters:
        shareId - (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 shareId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete a Share.

        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:
        shareId - (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 shareId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Delete a Share.

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

      • delete

        void delete​(java.lang.String shareId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete a Share.

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

      • get

        Share get​(java.lang.String shareId)
        Get single instance of a share

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

        Parameters:
        shareId - Share ID (required)
        Returns:
        com.vmware.nsx_policy.model.Share
        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

        Share get​(java.lang.String shareId,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Get single instance of a share

        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:
        shareId - Share ID (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Share
        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 shareId,
         com.vmware.vapi.bindings.client.AsyncCallback<Share> asyncCallback)
        Get single instance of a share

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

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

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

        Parameters:
        shareId - Share ID (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • get

        void get​(java.lang.String shareId,
         com.vmware.vapi.bindings.client.AsyncCallback<Share> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Get single instance of a share

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

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

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

      • list

        ShareListResult list​(java.lang.String cursor,
                     java.lang.Boolean includeMarkForDeleteObjects,
                     java.lang.String includedFields,
                     java.lang.Long pageSize,
                     java.lang.Boolean sortAscending,
                     java.lang.String sortBy)
        List shares

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

        Parameters:
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        includedFields - Comma separated list of fields that should be included in query result (optional)
        pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        Returns:
        com.vmware.nsx_policy.model.ShareListResult
        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

        ShareListResult list​(java.lang.String cursor,
                     java.lang.Boolean includeMarkForDeleteObjects,
                     java.lang.String includedFields,
                     java.lang.Long pageSize,
                     java.lang.Boolean sortAscending,
                     java.lang.String sortBy,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        List shares

        Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

        Parameters:
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        includedFields - Comma separated list of fields that should be included in query result (optional)
        pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ShareListResult
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • list

        void list​(java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ShareListResult> asyncCallback)
        List shares

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

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

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

        Parameters:
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        includedFields - Comma separated list of fields that should be included in query result (optional)
        pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • list

        void list​(java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<ShareListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        List shares

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

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

        Parameters:
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        includedFields - Comma separated list of fields that should be included in query result (optional)
        pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • patch

        void patch​(java.lang.String shareId,
           Share share)
        If a Share with the given ID already exists, update the share entity.

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

        Parameters:
        shareId - Share ID (required)
        share - (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 shareId,
           Share share,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If a Share with the given ID already exists, update the share entity.

        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:
        shareId - Share ID (required)
        share - (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 shareId,
           Share share,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        If a Share with the given ID already exists, update the share entity.

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

      • patch

        void patch​(java.lang.String shareId,
           Share share,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If a Share with the given ID already exists, update the share entity.

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

      • update

        Share update​(java.lang.String shareId,
             Share share)
        If a Share with the given ID already exists, and the revision is 0, throw error

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

        Parameters:
        shareId - Share ID (required)
        share - (required)
        Returns:
        com.vmware.nsx_policy.model.Share
        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

        Share update​(java.lang.String shareId,
             Share share,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If a Share with the given ID already exists, and the revision is 0, throw error

        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:
        shareId - Share ID (required)
        share - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Share
        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 shareId,
            Share share,
            com.vmware.vapi.bindings.client.AsyncCallback<Share> asyncCallback)
        If a Share with the given ID already exists, and the revision is 0, throw error

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

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

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

        Parameters:
        shareId - Share ID (required)
        share - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • update

        void update​(java.lang.String shareId,
            Share share,
            com.vmware.vapi.bindings.client.AsyncCallback<Share> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If a Share with the given ID already exists, and the revision is 0, throw error

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

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

        Parameters:
        shareId - Share ID (required)
        share - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.