com.vmware.nsx.logical_routers.routing.advertisement

Class RulesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.logical_routers.routing.advertisement.RulesStub

All Implemented Interfaces:

Rules, RulesTypes, com.vmware.vapi.bindings.Service

public class RulesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Rules

Remote stub implementation of the Rules 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.logical_routers.routing.advertisement.RulesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
RulesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
RulesStub(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
AdvertiseRuleList	get(java.lang.String logicalRouterId) Returns the advertisement rule list for the specified TIER1 logical router.
void	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<AdvertiseRuleList> asyncCallback) Returns the advertisement rule list for the specified TIER1 logical router.
void	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<AdvertiseRuleList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the advertisement rule list for the specified TIER1 logical router.
AdvertiseRuleList	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the advertisement rule list for the specified TIER1 logical router.
AdvertiseRuleList	update(java.lang.String logicalRouterId, AdvertiseRuleList advertiseRuleList) Modifies the advertisement rules on the specified logical router.
void	update(java.lang.String logicalRouterId, AdvertiseRuleList advertiseRuleList, com.vmware.vapi.bindings.client.AsyncCallback<AdvertiseRuleList> asyncCallback) Modifies the advertisement rules on the specified logical router.
void	update(java.lang.String logicalRouterId, AdvertiseRuleList advertiseRuleList, com.vmware.vapi.bindings.client.AsyncCallback<AdvertiseRuleList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies the advertisement rules on the specified logical router.
AdvertiseRuleList	update(java.lang.String logicalRouterId, AdvertiseRuleList advertiseRuleList, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies the advertisement rules on the specified logical router.

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

RulesStub

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

RulesStub

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

Method Detail

get

public AdvertiseRuleList get(java.lang.String logicalRouterId)

Description copied from interface: Rules

Returns the advertisement rule list for the specified TIER1 logical router.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-1s/

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

Specified by:

get in interface Rules

Parameters:

logicalRouterId - (required)

Returns:

com.vmware.nsx.model.AdvertiseRuleList

get

public AdvertiseRuleList get(java.lang.String logicalRouterId,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Returns the advertisement rule list for the specified TIER1 logical router.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-1s/

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:

get in interface Rules

Parameters:

logicalRouterId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.AdvertiseRuleList

get

public void get(java.lang.String logicalRouterId,
                com.vmware.vapi.bindings.client.AsyncCallback<AdvertiseRuleList> asyncCallback)

Description copied from interface: Rules

Returns the advertisement rule list for the specified TIER1 logical router.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-1s/

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

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

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

Specified by:

get in interface Rules

Parameters:

logicalRouterId - (required)

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

get

public void get(java.lang.String logicalRouterId,
                com.vmware.vapi.bindings.client.AsyncCallback<AdvertiseRuleList> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Returns the advertisement rule list for the specified TIER1 logical router.

Please use below Policy APIs.
GET /policy/api/v1/infra/tier-1s/

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

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

Specified by:

get in interface Rules

Parameters:

logicalRouterId - (required)

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

invocationConfig - Configuration for the method invocation.

update

public AdvertiseRuleList update(java.lang.String logicalRouterId,
                                AdvertiseRuleList advertiseRuleList)

Description copied from interface: Rules

Modifies the advertisement rules on the specified logical router. The PUT request must include all the rules with the networks parameter. Modifiable parameters are networks, display_name, and description. Set the rules list to empty to delete/clear all rules.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-1s/

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

Specified by:

update in interface Rules

Parameters:

logicalRouterId - (required)

advertiseRuleList - (required)

Returns:

com.vmware.nsx.model.AdvertiseRuleList

update

public AdvertiseRuleList update(java.lang.String logicalRouterId,
                                AdvertiseRuleList advertiseRuleList,
                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Modifies the advertisement rules on the specified logical router. The PUT request must include all the rules with the networks parameter. Modifiable parameters are networks, display_name, and description. Set the rules list to empty to delete/clear all rules.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-1s/

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:

update in interface Rules

Parameters:

logicalRouterId - (required)

advertiseRuleList - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.AdvertiseRuleList

update

public void update(java.lang.String logicalRouterId,
                   AdvertiseRuleList advertiseRuleList,
                   com.vmware.vapi.bindings.client.AsyncCallback<AdvertiseRuleList> asyncCallback)

Description copied from interface: Rules

Modifies the advertisement rules on the specified logical router. The PUT request must include all the rules with the networks parameter. Modifiable parameters are networks, display_name, and description. Set the rules list to empty to delete/clear all rules.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-1s/

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

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

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

Specified by:

update in interface Rules

Parameters:

logicalRouterId - (required)

advertiseRuleList - (required)

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

update

public void update(java.lang.String logicalRouterId,
                   AdvertiseRuleList advertiseRuleList,
                   com.vmware.vapi.bindings.client.AsyncCallback<AdvertiseRuleList> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Rules

Modifies the advertisement rules on the specified logical router. The PUT request must include all the rules with the networks parameter. Modifiable parameters are networks, display_name, and description. Set the rules list to empty to delete/clear all rules.

Please use below Policy APIs.
PUT /policy/api/v1/infra/tier-1s/

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

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

Specified by:

update in interface Rules

Parameters:

logicalRouterId - (required)

advertiseRuleList - (required)

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

invocationConfig - Configuration for the method invocation.