com.vmware.nsx_policy.infra.tags

Class EffectiveResourcesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx_policy.infra.tags.EffectiveResourcesStub

All Implemented Interfaces:

EffectiveResources, EffectiveResourcesTypes, com.vmware.vapi.bindings.Service

public class EffectiveResourcesStub
extends com.vmware.vapi.internal.bindings.Stub
implements EffectiveResources

Remote stub implementation of the EffectiveResources API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx_policy.infra.tags.EffectiveResourcesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
EffectiveResourcesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
EffectiveResourcesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
PolicyResourceReferenceListResult	list(java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.String filterText, 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 tag) Paginated list of all objects assigned with matching scope and tag values.
void	list(java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.String filterText, 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 tag, com.vmware.vapi.bindings.client.AsyncCallback<PolicyResourceReferenceListResult> asyncCallback) Paginated list of all objects assigned with matching scope and tag values.
void	list(java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.String filterText, 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 tag, com.vmware.vapi.bindings.client.AsyncCallback<PolicyResourceReferenceListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Paginated list of all objects assigned with matching scope and tag values.
PolicyResourceReferenceListResult	list(java.lang.String cursor, java.lang.String enforcementPointPath, java.lang.String filterText, 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 tag, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Paginated list of all objects assigned with matching scope and tag values.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EffectiveResourcesStub

public EffectiveResourcesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                              com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                              com.vmware.vapi.bindings.StubConfigurationBase config)

EffectiveResourcesStub

public EffectiveResourcesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                              com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

list

public PolicyResourceReferenceListResult list(java.lang.String cursor,
                                              java.lang.String enforcementPointPath,
                                              java.lang.String filterText,
                                              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 tag)

Description copied from interface: EffectiveResources

Paginated list of all objects assigned with matching scope and tag values. Objects are represented in form of resource reference. Sort option is available only on target_type and target_display_name properties.

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

Specified by:

list in interface EffectiveResources

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)

filterText - Filter text to restrict tagged objects list with matching filter text. (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)

tag - Tag value (optional)

Returns:

com.vmware.nsx_policy.model.PolicyResourceReferenceListResult

list

public PolicyResourceReferenceListResult list(java.lang.String cursor,
                                              java.lang.String enforcementPointPath,
                                              java.lang.String filterText,
                                              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 tag,
                                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: EffectiveResources

Paginated list of all objects assigned with matching scope and tag values. Objects are represented in form of resource reference. Sort option is available only on target_type and target_display_name 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.

Specified by:

list in interface EffectiveResources

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)

filterText - Filter text to restrict tagged objects list with matching filter text. (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)

tag - Tag value (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyResourceReferenceListResult

list

public void list(java.lang.String cursor,
                 java.lang.String enforcementPointPath,
                 java.lang.String filterText,
                 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 tag,
                 com.vmware.vapi.bindings.client.AsyncCallback<PolicyResourceReferenceListResult> asyncCallback)

Description copied from interface: EffectiveResources

Paginated list of all objects assigned with matching scope and tag values. Objects are represented in form of resource reference. Sort option is available only on target_type and target_display_name properties.

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

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

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

Specified by:

list in interface EffectiveResources

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)

filterText - Filter text to restrict tagged objects list with matching filter text. (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)

tag - Tag value (optional)

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

list

public void list(java.lang.String cursor,
                 java.lang.String enforcementPointPath,
                 java.lang.String filterText,
                 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 tag,
                 com.vmware.vapi.bindings.client.AsyncCallback<PolicyResourceReferenceListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: EffectiveResources

Paginated list of all objects assigned with matching scope and tag values. Objects are represented in form of resource reference. Sort option is available only on target_type and target_display_name 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_policy.model.PolicyResourceReferenceListResult

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

Specified by:

list in interface EffectiveResources

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)

filterText - Filter text to restrict tagged objects list with matching filter text. (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)

tag - Tag value (optional)

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

invocationConfig - Configuration for the method invocation.