Package com.vmware.nsx_policy.search

Interface Dsl

  • All Superinterfaces:
    DslTypes, com.vmware.vapi.bindings.Service
    All Known Implementing Classes:
    DslStub
    public interface Dsl
extends com.vmware.vapi.bindings.Service, DslTypes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      SearchResponse list​(java.lang.String query, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)
      DSL (Domain Specific Language) search API
      void list​(java.lang.String query, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<SearchResponse> asyncCallback)
      DSL (Domain Specific Language) search API
      void list​(java.lang.String query, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<SearchResponse> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      DSL (Domain Specific Language) search API
      SearchResponse list​(java.lang.String query, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      DSL (Domain Specific Language) search API

    • Method Detail

      • list

        SearchResponse list​(java.lang.String query,
                    java.lang.String cursor,
                    java.lang.String includedFields,
                    java.lang.Long pageSize,
                    java.lang.Boolean sortAscending,
                    java.lang.String sortBy)
        DSL (Domain Specific Language) search API

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

        Parameters:
        query - Search query (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        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.SearchResponse
        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

        SearchResponse list​(java.lang.String query,
                    java.lang.String cursor,
                    java.lang.String includedFields,
                    java.lang.Long pageSize,
                    java.lang.Boolean sortAscending,
                    java.lang.String sortBy,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        DSL (Domain Specific Language) search API

        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:
        query - Search query (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        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.SearchResponse
        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 query,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<SearchResponse> asyncCallback)
        DSL (Domain Specific Language) search API

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

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

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

        Parameters:
        query - Search query (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        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 query,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<SearchResponse> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        DSL (Domain Specific Language) search API

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

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

        Parameters:
        query - Search query (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        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.