com.vmware.nsx_policy.infra.realized_state.virtual_machines

Interface Tags

All Superinterfaces:

com.vmware.vapi.bindings.Service, TagsTypes

All Known Implementing Classes:

TagsStub

public interface Tags
extends com.vmware.vapi.bindings.Service, TagsTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.realized_state.virtual_machines.TagsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String virtualMachineId, VirtualMachineTagsUpdate virtualMachineTagsUpdate, java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Allows an admin to apply multiple tags to a virtual machine.
void	create(java.lang.String virtualMachineId, VirtualMachineTagsUpdate virtualMachineTagsUpdate, java.lang.String cursor, java.lang.String enforcementPointPath, 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<java.lang.Void> asyncCallback) Allows an admin to apply multiple tags to a virtual machine.
void	create(java.lang.String virtualMachineId, VirtualMachineTagsUpdate virtualMachineTagsUpdate, java.lang.String cursor, java.lang.String enforcementPointPath, 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<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Allows an admin to apply multiple tags to a virtual machine.
void	create(java.lang.String virtualMachineId, VirtualMachineTagsUpdate virtualMachineTagsUpdate, java.lang.String cursor, java.lang.String enforcementPointPath, 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) Allows an admin to apply multiple tags to a virtual machine.

Method Detail

create

void create(java.lang.String virtualMachineId,
            VirtualMachineTagsUpdate virtualMachineTagsUpdate,
            java.lang.String cursor,
            java.lang.String enforcementPointPath,
            java.lang.Boolean includeMarkForDeleteObjects,
            java.lang.String includedFields,
            java.lang.Long pageSize,
            java.lang.Boolean sortAscending,
            java.lang.String sortBy)

Allows an admin to apply multiple tags to a virtual machine. This operation does not store the intent on the policy side. It applies the tag directly on the specified enforcement point. This operation will replace the existing tags on the virtual machine with the ones that have been passed. If the application of tag fails on the enforcement point, then an error is reported. The admin will have to retry the operation again. Policy framework does not perform a retry. Failure could occur due to multiple reasons. For e.g enforcement point is down, Enforcement point could not apply the tag due to constraints like max tags limit exceeded, etc. NOTE: The \"virtual_machine_id\" field in the payload will be ignored and the virtual machine ID provided in the URL will be honored.

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

Parameters:

virtualMachineId - (required)

virtualMachineTagsUpdate - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

enforcementPointPath - String Path of the enforcement point (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)

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

create

void create(java.lang.String virtualMachineId,
            VirtualMachineTagsUpdate virtualMachineTagsUpdate,
            java.lang.String cursor,
            java.lang.String enforcementPointPath,
            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)

Allows an admin to apply multiple tags to a virtual machine. This operation does not store the intent on the policy side. It applies the tag directly on the specified enforcement point. This operation will replace the existing tags on the virtual machine with the ones that have been passed. If the application of tag fails on the enforcement point, then an error is reported. The admin will have to retry the operation again. Policy framework does not perform a retry. Failure could occur due to multiple reasons. For e.g enforcement point is down, Enforcement point could not apply the tag due to constraints like max tags limit exceeded, etc. NOTE: The \"virtual_machine_id\" field in the payload will be ignored and the virtual machine ID provided in the URL will be honored.

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:

virtualMachineId - (required)

virtualMachineTagsUpdate - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

enforcementPointPath - String Path of the enforcement point (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.

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

create

void create(java.lang.String virtualMachineId,
            VirtualMachineTagsUpdate virtualMachineTagsUpdate,
            java.lang.String cursor,
            java.lang.String enforcementPointPath,
            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<java.lang.Void> asyncCallback)

Allows an admin to apply multiple tags to a virtual machine. This operation does not store the intent on the policy side. It applies the tag directly on the specified enforcement point. This operation will replace the existing tags on the virtual machine with the ones that have been passed. If the application of tag fails on the enforcement point, then an error is reported. The admin will have to retry the operation again. Policy framework does not perform a retry. Failure could occur due to multiple reasons. For e.g enforcement point is down, Enforcement point could not apply the tag due to constraints like max tags limit exceeded, etc. NOTE: The \"virtual_machine_id\" field in the payload will be ignored and the virtual machine ID provided in the URL will be honored.

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:

virtualMachineId - (required)

virtualMachineTagsUpdate - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

enforcementPointPath - String Path of the enforcement point (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.

create

void create(java.lang.String virtualMachineId,
            VirtualMachineTagsUpdate virtualMachineTagsUpdate,
            java.lang.String cursor,
            java.lang.String enforcementPointPath,
            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<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Allows an admin to apply multiple tags to a virtual machine. This operation does not store the intent on the policy side. It applies the tag directly on the specified enforcement point. This operation will replace the existing tags on the virtual machine with the ones that have been passed. If the application of tag fails on the enforcement point, then an error is reported. The admin will have to retry the operation again. Policy framework does not perform a retry. Failure could occur due to multiple reasons. For e.g enforcement point is down, Enforcement point could not apply the tag due to constraints like max tags limit exceeded, etc. NOTE: The \"virtual_machine_id\" field in the payload will be ignored and the virtual machine ID provided in the URL will be honored.

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:

virtualMachineId - (required)

virtualMachineTagsUpdate - (required)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

enforcementPointPath - String Path of the enforcement point (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.