Package com.vmware.nsx_policy

Interface Infra

  • All Superinterfaces:
    InfraTypes, com.vmware.vapi.bindings.Service
    All Known Implementing Classes:
    InfraStub
    public interface Infra
extends com.vmware.vapi.bindings.Service, InfraTypes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Infra get​(java.lang.String basePath, java.lang.String filter, java.lang.String typeFilter)
      Read infra.
      void get​(java.lang.String basePath, java.lang.String filter, java.lang.String typeFilter, com.vmware.vapi.bindings.client.AsyncCallback<Infra> asyncCallback)
      Read infra.
      void get​(java.lang.String basePath, java.lang.String filter, java.lang.String typeFilter, com.vmware.vapi.bindings.client.AsyncCallback<Infra> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read infra.
      Infra get​(java.lang.String basePath, java.lang.String filter, java.lang.String typeFilter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read infra.
      void patch​(Infra infra, java.lang.Boolean enforceRevisionCheck)
      Patch API at infra level can be used in two flavours 1.
      void patch​(Infra infra, java.lang.Boolean enforceRevisionCheck, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Patch API at infra level can be used in two flavours 1.
      void patch​(Infra infra, java.lang.Boolean enforceRevisionCheck, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Patch API at infra level can be used in two flavours 1.
      void patch​(Infra infra, java.lang.Boolean enforceRevisionCheck, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Patch API at infra level can be used in two flavours 1.
      Infra update​(Infra infra)
      Updates only the single infra object.
      void update​(Infra infra, com.vmware.vapi.bindings.client.AsyncCallback<Infra> asyncCallback)
      Updates only the single infra object.
      void update​(Infra infra, com.vmware.vapi.bindings.client.AsyncCallback<Infra> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Updates only the single infra object.
      Infra update​(Infra infra, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Updates only the single infra object.

    • Method Detail

      • get

        Infra get​(java.lang.String basePath,
          java.lang.String filter,
          java.lang.String typeFilter)
        Read infra. Returns only the infra related properties. Inner object are not populated.

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

        Parameters:
        basePath - Base Path for retrieving hierarchical intent (optional)
        filter - Filter string as java regex (optional)
        typeFilter - Filter string to retrieve hierarchy. (optional)
        Returns:
        com.vmware.nsx_policy.model.Infra
        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

        Infra get​(java.lang.String basePath,
          java.lang.String filter,
          java.lang.String typeFilter,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read infra. Returns only the infra related properties. Inner object are not populated.

        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:
        basePath - Base Path for retrieving hierarchical intent (optional)
        filter - Filter string as java regex (optional)
        typeFilter - Filter string to retrieve hierarchy. (optional)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Infra
        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 basePath,
         java.lang.String filter,
         java.lang.String typeFilter,
         com.vmware.vapi.bindings.client.AsyncCallback<Infra> asyncCallback)
        Read infra. Returns only the infra related properties. Inner object are not populated.

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

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

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

        Parameters:
        basePath - Base Path for retrieving hierarchical intent (optional)
        filter - Filter string as java regex (optional)
        typeFilter - Filter string to retrieve hierarchy. (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • get

        void get​(java.lang.String basePath,
         java.lang.String filter,
         java.lang.String typeFilter,
         com.vmware.vapi.bindings.client.AsyncCallback<Infra> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read infra. Returns only the infra related properties. Inner object are not populated.

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

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

        Parameters:
        basePath - Base Path for retrieving hierarchical intent (optional)
        filter - Filter string as java regex (optional)
        typeFilter - Filter string to retrieve hierarchy. (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • patch

        void patch​(Infra infra,
           java.lang.Boolean enforceRevisionCheck)
        Patch API at infra level can be used in two flavours 1. Like a regular API to update Infra object 2. Hierarchical API: To create/update/delete entire or part of intent hierarchy Hierarchical API: Provides users a way to create entire or part of intent in single API invocation. Input is expressed in a tree format. Each node in tree can have multiple children of different types. System will resolve the dependencies of nodes within the intent tree and will create the model. Children for any node can be specified using ChildResourceReference or ChildPolicyConfigResource. If a resource is specified using ChildResourceReference then it will not be updated only its children will be updated. If Object is specified using ChildPolicyConfigResource, object along with its children will be updated. Hierarchical API can also be used to delete any sub-branch of entire tree.

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

        Parameters:
        infra - (required)
        enforceRevisionCheck - Force revision check (optional, default to false)
        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​(Infra infra,
           java.lang.Boolean enforceRevisionCheck,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Patch API at infra level can be used in two flavours 1. Like a regular API to update Infra object 2. Hierarchical API: To create/update/delete entire or part of intent hierarchy Hierarchical API: Provides users a way to create entire or part of intent in single API invocation. Input is expressed in a tree format. Each node in tree can have multiple children of different types. System will resolve the dependencies of nodes within the intent tree and will create the model. Children for any node can be specified using ChildResourceReference or ChildPolicyConfigResource. If a resource is specified using ChildResourceReference then it will not be updated only its children will be updated. If Object is specified using ChildPolicyConfigResource, object along with its children will be updated. Hierarchical API can also be used to delete any sub-branch of entire tree.

        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:
        infra - (required)
        enforceRevisionCheck - Force revision check (optional, default to false)
        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​(Infra infra,
           java.lang.Boolean enforceRevisionCheck,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Patch API at infra level can be used in two flavours 1. Like a regular API to update Infra object 2. Hierarchical API: To create/update/delete entire or part of intent hierarchy Hierarchical API: Provides users a way to create entire or part of intent in single API invocation. Input is expressed in a tree format. Each node in tree can have multiple children of different types. System will resolve the dependencies of nodes within the intent tree and will create the model. Children for any node can be specified using ChildResourceReference or ChildPolicyConfigResource. If a resource is specified using ChildResourceReference then it will not be updated only its children will be updated. If Object is specified using ChildPolicyConfigResource, object along with its children will be updated. Hierarchical API can also be used to delete any sub-branch of entire tree.

        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:
        infra - (required)
        enforceRevisionCheck - Force revision check (optional, default to false)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • patch

        void patch​(Infra infra,
           java.lang.Boolean enforceRevisionCheck,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Patch API at infra level can be used in two flavours 1. Like a regular API to update Infra object 2. Hierarchical API: To create/update/delete entire or part of intent hierarchy Hierarchical API: Provides users a way to create entire or part of intent in single API invocation. Input is expressed in a tree format. Each node in tree can have multiple children of different types. System will resolve the dependencies of nodes within the intent tree and will create the model. Children for any node can be specified using ChildResourceReference or ChildPolicyConfigResource. If a resource is specified using ChildResourceReference then it will not be updated only its children will be updated. If Object is specified using ChildPolicyConfigResource, object along with its children will be updated. Hierarchical API can also be used to delete any sub-branch of entire tree.

        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:
        infra - (required)
        enforceRevisionCheck - Force revision check (optional, default to false)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • update

        Infra update​(Infra infra)
        Updates only the single infra object. This does not allow hierarchical updates of entities.

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

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

        Infra update​(Infra infra,
             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Updates only the single infra object. This does not allow hierarchical updates of entities.

        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:
        infra - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Infra
        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​(Infra infra,
            com.vmware.vapi.bindings.client.AsyncCallback<Infra> asyncCallback)
        Updates only the single infra object. This does not allow hierarchical updates of entities.

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

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

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

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

      • update

        void update​(Infra infra,
            com.vmware.vapi.bindings.client.AsyncCallback<Infra> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Updates only the single infra object. This does not allow hierarchical updates of entities.

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

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

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