com.vmware.nsx.service_configs

Interface EffectiveProfiles

All Superinterfaces:

EffectiveProfilesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

EffectiveProfilesStub

public interface EffectiveProfiles
extends com.vmware.vapi.bindings.Service, EffectiveProfilesTypes

Field Summary

Fields inherited from interface com.vmware.nsx.service_configs.EffectiveProfilesTypes

_VAPI_SERVICE_ID, LIST_RESOURCE_TYPE_LOGICALPORT, LIST_RESOURCE_TYPE_LOGICALROUTER, LIST_RESOURCE_TYPE_LOGICALSWITCH, LIST_RESOURCE_TYPE_NSGROUP, LIST_RESOURCE_TYPE_TRANSPORTNODE, LIST_RESOURCE_TYPE_VIRTUALMACHINE

Method Summary

Modifier and Type	Method and Description
EffectiveProfileListResult	list(java.lang.String resourceId, java.lang.String resourceType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String profileType, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns the effective profiles applied to the specified Resource.
void	list(java.lang.String resourceId, java.lang.String resourceType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String profileType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<EffectiveProfileListResult> asyncCallback) Returns the effective profiles applied to the specified Resource.
void	list(java.lang.String resourceId, java.lang.String resourceType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String profileType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<EffectiveProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the effective profiles applied to the specified Resource.
EffectiveProfileListResult	list(java.lang.String resourceId, java.lang.String resourceType, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String profileType, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the effective profiles applied to the specified Resource.

Method Detail

list

EffectiveProfileListResult list(java.lang.String resourceId,
                                java.lang.String resourceType,
                                java.lang.String cursor,
                                java.lang.String includedFields,
                                java.lang.Long pageSize,
                                java.lang.String profileType,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy)

Returns the effective profiles applied to the specified Resource.

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

Parameters:

resourceId - The resource for which the effective profiles are to be fetched (required)

resourceType - Valid Resource type in effective profiles API (required)

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

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)

profileType - Fetch effectivw profiles of the given profile_type (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx.model.EffectiveProfileListResult

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

EffectiveProfileListResult list(java.lang.String resourceId,
                                java.lang.String resourceType,
                                java.lang.String cursor,
                                java.lang.String includedFields,
                                java.lang.Long pageSize,
                                java.lang.String profileType,
                                java.lang.Boolean sortAscending,
                                java.lang.String sortBy,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the effective profiles applied to the specified Resource.

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:

resourceId - The resource for which the effective profiles are to be fetched (required)

resourceType - Valid Resource type in effective profiles API (required)

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

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)

profileType - Fetch effectivw profiles of the given profile_type (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.EffectiveProfileListResult

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 resourceId,
          java.lang.String resourceType,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String profileType,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<EffectiveProfileListResult> asyncCallback)

Returns the effective profiles applied to the specified Resource.

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

Invocation Result:
com.vmware.nsx.model.EffectiveProfileListResult

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

Parameters:

resourceId - The resource for which the effective profiles are to be fetched (required)

resourceType - Valid Resource type in effective profiles API (required)

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

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)

profileType - Fetch effectivw profiles of the given profile_type (optional)

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 resourceId,
          java.lang.String resourceType,
          java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String profileType,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<EffectiveProfileListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the effective profiles applied to the specified Resource.

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.model.EffectiveProfileListResult

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

Parameters:

resourceId - The resource for which the effective profiles are to be fetched (required)

resourceType - Valid Resource type in effective profiles API (required)

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

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)

profileType - Fetch effectivw profiles of the given profile_type (optional)

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.