Package com.vmware.nsx_policy.global_infra

Interface Labels

  • All Superinterfaces:
    LabelsTypes, com.vmware.vapi.bindings.Service
    All Known Implementing Classes:
    LabelsStub
    public interface Labels
extends com.vmware.vapi.bindings.Service, LabelsTypes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      PolicyLabel get​(java.lang.String labelId)
      Read a label.
      void get​(java.lang.String labelId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyLabel> asyncCallback)
      Read a label.
      void get​(java.lang.String labelId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyLabel> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read a label.
      PolicyLabel get​(java.lang.String labelId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read a label.
      PolicyLabelListResult 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)
      Paginated list of all labels for infra.
      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<PolicyLabelListResult> asyncCallback)
      Paginated list of all labels for infra.
      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<PolicyLabelListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Paginated list of all labels for infra.
      PolicyLabelListResult 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)
      Paginated list of all labels for infra.

    • Method Detail

      • get

        PolicyLabel get​(java.lang.String labelId)
        Read a label.

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

        Parameters:
        labelId - (required)
        Returns:
        com.vmware.nsx_policy.model.PolicyLabel
        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

        PolicyLabel get​(java.lang.String labelId,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read a label.

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

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

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

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

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

      • get

        void get​(java.lang.String labelId,
         com.vmware.vapi.bindings.client.AsyncCallback<PolicyLabel> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read a label.

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

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

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

      • list

        PolicyLabelListResult 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)
        Paginated list of all labels 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)
        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.PolicyLabelListResult
        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

        PolicyLabelListResult 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)
        Paginated list of all labels 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)
        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.PolicyLabelListResult
        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<PolicyLabelListResult> asyncCallback)
        Paginated list of all labels for infra.

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

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

        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<PolicyLabelListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Paginated list of all labels 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.PolicyLabelListResult

        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.