com.vmware.nsx_policy.global_infra.domains.gateway_policies

Interface Rules

All Superinterfaces:

RulesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RulesStub

public interface Rules
extends com.vmware.vapi.bindings.Service, RulesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.global_infra.domains.gateway_policies.RulesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
Rule	get(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId) Read rule
void	get(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback) Read rule
void	get(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read rule
Rule	get(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String ruleId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read rule
RuleListResult	list(java.lang.String domainId, java.lang.String gatewayPolicyId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) List rules
void	list(java.lang.String domainId, java.lang.String gatewayPolicyId, 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<RuleListResult> asyncCallback) List rules
void	list(java.lang.String domainId, java.lang.String gatewayPolicyId, 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<RuleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List rules
RuleListResult	list(java.lang.String domainId, java.lang.String gatewayPolicyId, 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) List rules

Method Detail

get

Rule get(java.lang.String domainId,
         java.lang.String gatewayPolicyId,
         java.lang.String ruleId)

Read rule

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

Returns:

com.vmware.nsx_policy.model.Rule

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

get

Rule get(java.lang.String domainId,
         java.lang.String gatewayPolicyId,
         java.lang.String ruleId,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read rule

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:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.Rule

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

get

void get(java.lang.String domainId,
         java.lang.String gatewayPolicyId,
         java.lang.String ruleId,
         com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback)

Read rule

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

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

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

get

void get(java.lang.String domainId,
         java.lang.String gatewayPolicyId,
         java.lang.String ruleId,
         com.vmware.vapi.bindings.client.AsyncCallback<Rule> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read rule

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

ruleId - (required)

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

invocationConfig - Configuration for the method invocation.

list

RuleListResult list(java.lang.String domainId,
                    java.lang.String gatewayPolicyId,
                    java.lang.String cursor,
                    java.lang.Boolean includeMarkForDeleteObjects,
                    java.lang.String includedFields,
                    java.lang.Long pageSize,
                    java.lang.Boolean sortAscending,
                    java.lang.String sortBy)

List rules

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

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

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

RuleListResult list(java.lang.String domainId,
                    java.lang.String gatewayPolicyId,
                    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)

List rules

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:

domainId - (required)

gatewayPolicyId - (required)

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

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 domainId,
          java.lang.String gatewayPolicyId,
          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<RuleListResult> asyncCallback)

List rules

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

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

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 domainId,
          java.lang.String gatewayPolicyId,
          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<RuleListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List rules

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

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.