com.vmware.nsx_policy

Interface OrgRoot

All Superinterfaces:

OrgRootTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

OrgRootStub

public interface OrgRoot
extends com.vmware.vapi.bindings.Service, OrgRootTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.OrgRootTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
OrgRoot	get(java.lang.String basePath, java.lang.String filter, java.lang.String typeFilter) Read Org Root.
void	get(java.lang.String basePath, java.lang.String filter, java.lang.String typeFilter, com.vmware.vapi.bindings.client.AsyncCallback<OrgRoot> asyncCallback) Read Org Root.
void	get(java.lang.String basePath, java.lang.String filter, java.lang.String typeFilter, com.vmware.vapi.bindings.client.AsyncCallback<OrgRoot> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read Org Root.
OrgRoot	get(java.lang.String basePath, java.lang.String filter, java.lang.String typeFilter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read Org Root.
void	patch(OrgRoot orgRoot, java.lang.Boolean enforceRevisionCheck) Patch API at org-root to create/update/delete entire or part of intent hierarchy.
void	patch(OrgRoot orgRoot, java.lang.Boolean enforceRevisionCheck, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Patch API at org-root to create/update/delete entire or part of intent hierarchy.
void	patch(OrgRoot orgRoot, java.lang.Boolean enforceRevisionCheck, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Patch API at org-root to create/update/delete entire or part of intent hierarchy.
void	patch(OrgRoot orgRoot, java.lang.Boolean enforceRevisionCheck, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Patch API at org-root to create/update/delete entire or part of intent hierarchy.

Method Detail

get

OrgRoot get(java.lang.String basePath,
            java.lang.String filter,
            java.lang.String typeFilter)

Read Org Root. Returns only the org root related properties. Inner object are not populated. For Hierarchical Get, base_path request parameter can be used.

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

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

OrgRoot get(java.lang.String basePath,
            java.lang.String filter,
            java.lang.String typeFilter,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read Org Root. Returns only the org root related properties. Inner object are not populated. For Hierarchical Get, base_path request parameter can be used.

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

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<OrgRoot> asyncCallback)

Read Org Root. Returns only the org root related properties. Inner object are not populated. For Hierarchical Get, base_path request parameter can be used.

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

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

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<OrgRoot> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read Org Root. Returns only the org root related properties. Inner object are not populated. For Hierarchical Get, base_path request parameter can be used.

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

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(OrgRoot orgRoot,
           java.lang.Boolean enforceRevisionCheck)

Patch API at org-root 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 dependecies 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:

orgRoot - (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(OrgRoot orgRoot,
           java.lang.Boolean enforceRevisionCheck,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Patch API at org-root 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 dependecies 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:

orgRoot - (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(OrgRoot orgRoot,
           java.lang.Boolean enforceRevisionCheck,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Patch API at org-root 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 dependecies 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:

orgRoot - (required)

enforceRevisionCheck - Force revision check (optional, default to false)

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

patch

void patch(OrgRoot orgRoot,
           java.lang.Boolean enforceRevisionCheck,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Patch API at org-root 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 dependecies 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:

orgRoot - (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.