com.vmware.nsx_policy.global_infra.context_profiles.custom_attributes

Interface Default

All Superinterfaces:

DefaultTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

DefaultStub

public interface Default
extends com.vmware.vapi.bindings.Service, DefaultTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.global_infra.context_profiles.custom_attributes.DefaultTypes

_VAPI_SERVICE_ID, CREATE_ACTION_ADD, CREATE_ACTION_REMOVE, LIST_ATTRIBUTE_SOURCE_ALL, LIST_ATTRIBUTE_SOURCE_CUSTOM, LIST_ATTRIBUTE_SOURCE_SYSTEM

Method Summary

Modifier and Type	Method and Description
void	create(PolicyCustomAttributes policyCustomAttributes, java.lang.String action) This API adds/removes custom attribute values from list for a given attribute key.
void	create(PolicyCustomAttributes policyCustomAttributes, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) This API adds/removes custom attribute values from list for a given attribute key.
void	create(PolicyCustomAttributes policyCustomAttributes, java.lang.String action, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API adds/removes custom attribute values from list for a given attribute key.
void	create(PolicyCustomAttributes policyCustomAttributes, java.lang.String action, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API adds/removes custom attribute values from list for a given attribute key.
PolicyContextProfileListResult	list(java.lang.String attributeKey, java.lang.String attributeSource, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) This API updates custom attribute value list for given key.
void	list(java.lang.String attributeKey, java.lang.String attributeSource, 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<PolicyContextProfileListResult> asyncCallback) This API updates custom attribute value list for given key.
void	list(java.lang.String attributeKey, java.lang.String attributeSource, 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<PolicyContextProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API updates custom attribute value list for given key.
PolicyContextProfileListResult	list(java.lang.String attributeKey, java.lang.String attributeSource, 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) This API updates custom attribute value list for given key.
void	patch(PolicyCustomAttributes policyCustomAttributes) This API updates custom attribute value list for given key.
void	patch(PolicyCustomAttributes policyCustomAttributes, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) This API updates custom attribute value list for given key.
void	patch(PolicyCustomAttributes policyCustomAttributes, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API updates custom attribute value list for given key.
void	patch(PolicyCustomAttributes policyCustomAttributes, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API updates custom attribute value list for given key.

Method Detail

create

void create(PolicyCustomAttributes policyCustomAttributes,
            java.lang.String action)

This API adds/removes custom attribute values from list for a given attribute key.

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

Parameters:

policyCustomAttributes - (required)

action - Add or Remove Custom Context Profile Attribute values. (required)

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(PolicyCustomAttributes policyCustomAttributes,
            java.lang.String action,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API adds/removes custom attribute values from list for a given attribute key.

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:

policyCustomAttributes - (required)

action - Add or Remove Custom Context Profile Attribute values. (required)

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(PolicyCustomAttributes policyCustomAttributes,
            java.lang.String action,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

This API adds/removes custom attribute values from list for a given attribute key.

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:

policyCustomAttributes - (required)

action - Add or Remove Custom Context Profile Attribute values. (required)

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

create

void create(PolicyCustomAttributes policyCustomAttributes,
            java.lang.String action,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API adds/removes custom attribute values from list for a given attribute key.

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:

policyCustomAttributes - (required)

action - Add or Remove Custom Context Profile Attribute values. (required)

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

invocationConfig - Configuration for the method invocation.

list

PolicyContextProfileListResult list(java.lang.String attributeKey,
                                    java.lang.String attributeSource,
                                    java.lang.String cursor,
                                    java.lang.Boolean includeMarkForDeleteObjects,
                                    java.lang.String includedFields,
                                    java.lang.Long pageSize,
                                    java.lang.Boolean sortAscending,
                                    java.lang.String sortBy)

This API updates custom attribute value list for given key.

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

Parameters:

attributeKey - Fetch attributes and sub-attributes for the given attribute key (optional)

attributeSource - Source of the attribute, System Defined or custom (optional, default to SYSTEM)

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

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

PolicyContextProfileListResult list(java.lang.String attributeKey,
                                    java.lang.String attributeSource,
                                    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)

This API updates custom attribute value list for given key.

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:

attributeKey - Fetch attributes and sub-attributes for the given attribute key (optional)

attributeSource - Source of the attribute, System Defined or custom (optional, default to SYSTEM)

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

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 attributeKey,
          java.lang.String attributeSource,
          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<PolicyContextProfileListResult> asyncCallback)

This API updates custom attribute value list for given key.

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

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

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

Parameters:

attributeKey - Fetch attributes and sub-attributes for the given attribute key (optional)

attributeSource - Source of the attribute, System Defined or custom (optional, default to SYSTEM)

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 attributeKey,
          java.lang.String attributeSource,
          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<PolicyContextProfileListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API updates custom attribute value list for given key.

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

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

Parameters:

attributeKey - Fetch attributes and sub-attributes for the given attribute key (optional)

attributeSource - Source of the attribute, System Defined or custom (optional, default to SYSTEM)

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.

patch

void patch(PolicyCustomAttributes policyCustomAttributes)

This API updates custom attribute value list for given key.

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

Parameters:

policyCustomAttributes - (required)

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(PolicyCustomAttributes policyCustomAttributes,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API updates custom attribute value list for given key.

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:

policyCustomAttributes - (required)

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(PolicyCustomAttributes policyCustomAttributes,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

This API updates custom attribute value list for given key.

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:

policyCustomAttributes - (required)

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

patch

void patch(PolicyCustomAttributes policyCustomAttributes,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API updates custom attribute value list for given key.

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:

policyCustomAttributes - (required)

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

invocationConfig - Configuration for the method invocation.