com.vmware.nsx_global_policy.global_infra

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_global_policy.global_infra.TagsTypes

_VAPI_SERVICE_ID, LIST_SOURCE_AMAZON, LIST_SOURCE_ANY, LIST_SOURCE_AZURE, LIST_SOURCE_NSX

Method Summary

Modifier and Type	Method and Description
TagInfoListResult	list(java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String tag) Returns paginated list of all unique tags.
void	list(java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String tag, com.vmware.vapi.bindings.client.AsyncCallback<TagInfoListResult> asyncCallback) Returns paginated list of all unique tags.
void	list(java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String tag, com.vmware.vapi.bindings.client.AsyncCallback<TagInfoListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns paginated list of all unique tags.
TagInfoListResult	list(java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String tag, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns paginated list of all unique tags.

Method Detail

list

TagInfoListResult list(java.lang.String cursor,
                       java.lang.String enforcementPointPath,
                       java.lang.Boolean includeMarkForDeleteObjects,
                       java.lang.String includedFields,
                       java.lang.Long pageSize,
                       java.lang.String scope,
                       java.lang.Boolean sortAscending,
                       java.lang.String sortBy,
                       java.lang.String source,
                       java.lang.String tag)

Returns paginated list of all unique tags. Supports filtering by scope, tag and source from which tags are synced. Supports starts with, ends with, equals and contains operators on scope and tag values. To filter tags by starts with on scope or tag, use '*' as suffix after the value. To filter tags by ends with on scope or tag, use '*' as prefix before the value. To filter tags by contain on scope or tag, use '*' as prefix and suffix on the value. Below special characters in the filter value needs to be escaped with hex values. - Character '&' needs to be escaped as '%26' - Character '[' needs to be escaped as '%5B' - Character ']' needs to be escaped as '%5D' - Character '+' needs to be escaped as '%2B' - Character '#' needs to be escaped as '%23' Sort option for list of unique tags is available only on tag and scope properties.

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)

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)

scope - Tag scope (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Source from which tags are synced. (optional)

tag - Tag value (optional)

Returns:

com.vmware.nsx_global_policy.model.TagInfoListResult

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

TagInfoListResult list(java.lang.String cursor,
                       java.lang.String enforcementPointPath,
                       java.lang.Boolean includeMarkForDeleteObjects,
                       java.lang.String includedFields,
                       java.lang.Long pageSize,
                       java.lang.String scope,
                       java.lang.Boolean sortAscending,
                       java.lang.String sortBy,
                       java.lang.String source,
                       java.lang.String tag,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns paginated list of all unique tags. Supports filtering by scope, tag and source from which tags are synced. Supports starts with, ends with, equals and contains operators on scope and tag values. To filter tags by starts with on scope or tag, use '*' as suffix after the value. To filter tags by ends with on scope or tag, use '*' as prefix before the value. To filter tags by contain on scope or tag, use '*' as prefix and suffix on the value. Below special characters in the filter value needs to be escaped with hex values. - Character '&' needs to be escaped as '%26' - Character '[' needs to be escaped as '%5B' - Character ']' needs to be escaped as '%5D' - Character '+' needs to be escaped as '%2B' - Character '#' needs to be escaped as '%23' Sort option for list of unique tags is available only on tag and scope properties.

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)

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)

scope - Tag scope (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Source from which tags are synced. (optional)

tag - Tag value (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_global_policy.model.TagInfoListResult

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.String enforcementPointPath,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String scope,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String source,
          java.lang.String tag,
          com.vmware.vapi.bindings.client.AsyncCallback<TagInfoListResult> asyncCallback)

Returns paginated list of all unique tags. Supports filtering by scope, tag and source from which tags are synced. Supports starts with, ends with, equals and contains operators on scope and tag values. To filter tags by starts with on scope or tag, use '*' as suffix after the value. To filter tags by ends with on scope or tag, use '*' as prefix before the value. To filter tags by contain on scope or tag, use '*' as prefix and suffix on the value. Below special characters in the filter value needs to be escaped with hex values. - Character '&' needs to be escaped as '%26' - Character '[' needs to be escaped as '%5B' - Character ']' needs to be escaped as '%5D' - Character '+' needs to be escaped as '%2B' - Character '#' needs to be escaped as '%23' Sort option for list of unique tags is available only on tag and scope properties.

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

Invocation Result:
com.vmware.nsx_global_policy.model.TagInfoListResult

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)

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)

scope - Tag scope (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Source from which tags are synced. (optional)

tag - Tag value (optional)

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

list

void list(java.lang.String cursor,
          java.lang.String enforcementPointPath,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String scope,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String source,
          java.lang.String tag,
          com.vmware.vapi.bindings.client.AsyncCallback<TagInfoListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns paginated list of all unique tags. Supports filtering by scope, tag and source from which tags are synced. Supports starts with, ends with, equals and contains operators on scope and tag values. To filter tags by starts with on scope or tag, use '*' as suffix after the value. To filter tags by ends with on scope or tag, use '*' as prefix before the value. To filter tags by contain on scope or tag, use '*' as prefix and suffix on the value. Below special characters in the filter value needs to be escaped with hex values. - Character '&' needs to be escaped as '%26' - Character '[' needs to be escaped as '%5B' - Character ']' needs to be escaped as '%5D' - Character '+' needs to be escaped as '%2B' - Character '#' needs to be escaped as '%23' Sort option for list of unique tags is available only on tag and scope properties.

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_global_policy.model.TagInfoListResult

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)

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)

scope - Tag scope (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Source from which tags are synced. (optional)

tag - Tag value (optional)

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

invocationConfig - Configuration for the method invocation.