Package com.vmware.nsx_policy.infra

Interface Services

  • All Superinterfaces:
    com.vmware.vapi.bindings.Service, ServicesTypes
    All Known Implementing Classes:
    ServicesStub
    public interface Services
extends com.vmware.vapi.bindings.Service, ServicesTypes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete​(java.lang.String serviceId)
      Delete Service
      void delete​(java.lang.String serviceId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Delete Service
      void delete​(java.lang.String serviceId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete Service
      void delete​(java.lang.String serviceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete Service
      Service get​(java.lang.String serviceId)
      Read a service
      void get​(java.lang.String serviceId, com.vmware.vapi.bindings.client.AsyncCallback<Service> asyncCallback)
      Read a service
      void get​(java.lang.String serviceId, com.vmware.vapi.bindings.client.AsyncCallback<Service> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read a service
      Service get​(java.lang.String serviceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read a service
      ServiceListResult list​(java.lang.String cursor, java.lang.Boolean defaultService, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)
      Paginated list of Services for infra.
      void list​(java.lang.String cursor, java.lang.Boolean defaultService, 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<ServiceListResult> asyncCallback)
      Paginated list of Services for infra.
      void list​(java.lang.String cursor, java.lang.Boolean defaultService, 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<ServiceListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Paginated list of Services for infra.
      ServiceListResult list​(java.lang.String cursor, java.lang.Boolean defaultService, 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)
      Paginated list of Services for infra.
      void patch​(java.lang.String serviceId, Service service)
      Create a new service if a service with the given ID does not already exist.
      void patch​(java.lang.String serviceId, Service service, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Create a new service if a service with the given ID does not already exist.
      void patch​(java.lang.String serviceId, Service service, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Create a new service if a service with the given ID does not already exist.
      void patch​(java.lang.String serviceId, Service service, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Create a new service if a service with the given ID does not already exist.
      Service update​(java.lang.String serviceId, Service service)
      Create a new service if a service with the given ID does not already exist.
      void update​(java.lang.String serviceId, Service service, com.vmware.vapi.bindings.client.AsyncCallback<Service> asyncCallback)
      Create a new service if a service with the given ID does not already exist.
      void update​(java.lang.String serviceId, Service service, com.vmware.vapi.bindings.client.AsyncCallback<Service> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Create a new service if a service with the given ID does not already exist.
      Service update​(java.lang.String serviceId, Service service, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Create a new service if a service with the given ID does not already exist.

    • Method Detail

      • delete

        void delete​(java.lang.String serviceId)
        Delete Service

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

        Parameters:
        serviceId - Service ID (required)
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • delete

        void delete​(java.lang.String serviceId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete Service

        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:
        serviceId - Service ID (required)
        invocationConfig - Configuration for the method invocation.
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • delete

        void delete​(java.lang.String serviceId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Delete Service

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

      • delete

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

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

      • get

        Service get​(java.lang.String serviceId)
        Read a service

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

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

        Service get​(java.lang.String serviceId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read a service

        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:
        serviceId - Service ID (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Service
        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 serviceId,
         com.vmware.vapi.bindings.client.AsyncCallback<Service> asyncCallback)
        Read a service

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

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

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

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

      • get

        void get​(java.lang.String serviceId,
         com.vmware.vapi.bindings.client.AsyncCallback<Service> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read a service

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

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

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

      • list

        ServiceListResult list​(java.lang.String cursor,
                       java.lang.Boolean defaultService,
                       java.lang.Boolean includeMarkForDeleteObjects,
                       java.lang.String includedFields,
                       java.lang.Long pageSize,
                       java.lang.Boolean sortAscending,
                       java.lang.String sortBy)
        Paginated list of Services for infra.

        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)
        defaultService - Fetch all default services (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.ServiceListResult
        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

        ServiceListResult list​(java.lang.String cursor,
                       java.lang.Boolean defaultService,
                       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)
        Paginated list of Services for infra.

        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)
        defaultService - Fetch all default services (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.ServiceListResult
        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 defaultService,
          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<ServiceListResult> asyncCallback)
        Paginated list of Services for infra.

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

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

        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)
        defaultService - Fetch all default services (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 defaultService,
          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<ServiceListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Paginated list of Services for infra.

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

        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)
        defaultService - Fetch all default services (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 serviceId,
           Service service)
        Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, patch the service including the nested service entries.

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

        Parameters:
        serviceId - Service ID (required)
        service - (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 serviceId,
           Service service,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, patch the service including the nested service entries.

        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:
        serviceId - Service ID (required)
        service - (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 serviceId,
           Service service,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, patch the service including the nested service entries.

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

      • patch

        void patch​(java.lang.String serviceId,
           Service service,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, patch the service including the nested service entries.

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

      • update

        Service update​(java.lang.String serviceId,
               Service service)
        Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, update the service including the nested service entries. This is a full replace.

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

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

        Service update​(java.lang.String serviceId,
               Service service,
               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, update the service including the nested service entries. This is a full replace.

        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:
        serviceId - Service ID (required)
        service - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Service
        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 serviceId,
            Service service,
            com.vmware.vapi.bindings.client.AsyncCallback<Service> asyncCallback)
        Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, update the service including the nested service entries. This is a full replace.

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

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

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

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

      • update

        void update​(java.lang.String serviceId,
            Service service,
            com.vmware.vapi.bindings.client.AsyncCallback<Service> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Create a new service if a service with the given ID does not already exist. Creates new service entries if populated in the service. If a service with the given ID already exists, update the service including the nested service entries. This is a full replace.

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

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

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