com.vmware.nsx_policy.infra.context_profiles

Interface Attributes

All Superinterfaces:

AttributesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

AttributesStub

public interface Attributes
extends com.vmware.vapi.bindings.Service, AttributesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.context_profiles.AttributesTypes

_VAPI_SERVICE_ID, LIST_ATTRIBUTE_SOURCE_ALL, LIST_ATTRIBUTE_SOURCE_CUSTOM, LIST_ATTRIBUTE_SOURCE_SYSTEM

Method Summary

Modifier and Type	Method and Description
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) Returns supported attribute and sub-attributes for specified attribute key with their supported values, if provided in query/request parameter, else will fetch all supported attributes and sub-attributes for all supported attribute keys.
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) Returns supported attribute and sub-attributes for specified attribute key with their supported values, if provided in query/request parameter, else will fetch all supported attributes and sub-attributes for all supported attribute keys.
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) Returns supported attribute and sub-attributes for specified attribute key with their supported values, if provided in query/request parameter, else will fetch all supported attributes and sub-attributes for all supported attribute keys.
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) Returns supported attribute and sub-attributes for specified attribute key with their supported values, if provided in query/request parameter, else will fetch all supported attributes and sub-attributes for all supported attribute keys.

Method Detail

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)

Returns supported attribute and sub-attributes for specified attribute key with their supported values, if provided in query/request parameter, else will fetch all supported attributes and sub-attributes for all supported attribute keys. Alternatively, to get a list of supported attributes and sub-attributes fire the following REST API GET https:///policy/api/v1/infra/context-profiles/attributes

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)

Returns supported attribute and sub-attributes for specified attribute key with their supported values, if provided in query/request parameter, else will fetch all supported attributes and sub-attributes for all supported attribute keys. Alternatively, to get a list of supported attributes and sub-attributes fire the following REST API GET https:///policy/api/v1/infra/context-profiles/attributes

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)

Returns supported attribute and sub-attributes for specified attribute key with their supported values, if provided in query/request parameter, else will fetch all supported attributes and sub-attributes for all supported attribute keys. Alternatively, to get a list of supported attributes and sub-attributes fire the following REST API GET https:///policy/api/v1/infra/context-profiles/attributes

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)

Returns supported attribute and sub-attributes for specified attribute key with their supported values, if provided in query/request parameter, else will fetch all supported attributes and sub-attributes for all supported attribute keys. Alternatively, to get a list of supported attributes and sub-attributes fire the following REST API GET https:///policy/api/v1/infra/context-profiles/attributes

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.