Class DslStub

  • All Implemented Interfaces:
    Dsl, DslTypes, com.vmware.vapi.bindings.Service

    public class DslStub
    extends com.vmware.vapi.internal.bindings.Stub
    implements Dsl
    Remote stub implementation of the Dsl API service.

    WARNING: Internal class, subject to change in future versions.

    • Field Summary

      • Fields inherited from class com.vmware.vapi.internal.bindings.Stub

        apiProvider, converter, ifaceId, retryPolicy, securityContext
    • Constructor Summary

      Constructors 
      Constructor Description
      DslStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      DslStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)  
    • Method Summary

      All Methods Instance Methods Concrete 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
      • Methods inherited from class com.vmware.vapi.internal.bindings.Stub

        invokeMethod, invokeMethodAsync, invokeStreamMethod, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • DslStub

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

        public DslStub​(com.vmware.vapi.core.ApiProvider apiProvider,
                       com.vmware.vapi.bindings.StubConfigurationBase config)
    • Method Detail

      • list

        public 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)
        Description copied from interface: Dsl
        DSL (Domain Specific Language) search API

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

        Specified by:
        list in interface Dsl
        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
      • list

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

        Specified by:
        list in interface Dsl
        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
      • list

        public 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)
        Description copied from interface: Dsl
        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

        Specified by:
        list in interface Dsl
        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

        public 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)
        Description copied from interface: Dsl
        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

        Specified by:
        list in interface Dsl
        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.