com.vmware.nsx_policy.global_infra.domains

Interface GatewayPolicies

All Superinterfaces:

GatewayPoliciesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

GatewayPoliciesStub

public interface GatewayPolicies
extends com.vmware.vapi.bindings.Service, GatewayPoliciesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.global_infra.domains.GatewayPoliciesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
GatewayPolicy	get(java.lang.String domainId, java.lang.String gatewayPolicyId) Read gateway policy for a domain.
void	get(java.lang.String domainId, java.lang.String gatewayPolicyId, com.vmware.vapi.bindings.client.AsyncCallback<GatewayPolicy> asyncCallback) Read gateway policy for a domain.
void	get(java.lang.String domainId, java.lang.String gatewayPolicyId, com.vmware.vapi.bindings.client.AsyncCallback<GatewayPolicy> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read gateway policy for a domain.
GatewayPolicy	get(java.lang.String domainId, java.lang.String gatewayPolicyId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read gateway policy for a domain.
GatewayPolicyListResult	list(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.Boolean includeRuleCount, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) List all gateway policies for specified Domain.
void	list(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.Boolean includeRuleCount, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<GatewayPolicyListResult> asyncCallback) List all gateway policies for specified Domain.
void	list(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.Boolean includeRuleCount, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<GatewayPolicyListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List all gateway policies for specified Domain.
GatewayPolicyListResult	list(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.Boolean includeRuleCount, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List all gateway policies for specified Domain.

Method Detail

get

GatewayPolicy get(java.lang.String domainId,
                  java.lang.String gatewayPolicyId)

Read gateway policy for a domain.

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

Returns:

com.vmware.nsx_policy.model.GatewayPolicy

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

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

Read gateway policy for a domain.

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)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.GatewayPolicy

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,
         com.vmware.vapi.bindings.client.AsyncCallback<GatewayPolicy> asyncCallback)

Read gateway policy for a domain.

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

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

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

get

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

Read gateway policy for a domain.

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

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

Parameters:

domainId - (required)

gatewayPolicyId - (required)

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

invocationConfig - Configuration for the method invocation.

list

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

List all gateway policies for specified Domain.

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

Parameters:

domainId - (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)

includeRuleCount - Include the count of rules in policy (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.GatewayPolicyListResult

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

GatewayPolicyListResult list(java.lang.String domainId,
                             java.lang.String cursor,
                             java.lang.Boolean includeMarkForDeleteObjects,
                             java.lang.Boolean includeRuleCount,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List all gateway policies for specified Domain.

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)

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)

includeRuleCount - Include the count of rules in policy (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.GatewayPolicyListResult

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

List all gateway policies for specified Domain.

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

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

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

Parameters:

domainId - (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)

includeRuleCount - Include the count of rules in policy (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 cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.Boolean includeRuleCount,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<GatewayPolicyListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List all gateway policies for specified Domain.

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

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

Parameters:

domainId - (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)

includeRuleCount - Include the count of rules in policy (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.