BaseRuleListResult (Java SDK for NSX Global Policy API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx_global_policy.model.BaseRuleListResult

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class BaseRuleListResult
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Paged Collection of Rules

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BaseRuleListResult.Builder
Builder class for BaseRuleListResult.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BaseRuleListResult.Builder` Builder class for `BaseRuleListResult`.

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

BaseRuleListResult()
Default constructor.

protected BaseRuleListResult(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`BaseRuleListResult()` Default constructor.
`protected`	`BaseRuleListResult(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static BaseRuleListResult`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static BaseRuleListResult`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getCursor()` Opaque cursor to be used for getting next page of records (supplied by current result page) This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.Long`	`getResultCount()` Count of results found (across all pages), set only on first page format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getSchema()` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`SelfResourceLink`	`getSelf()`
`java.lang.Boolean`	`getSortAscending()` If true, results are sorted in ascending order This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getSortBy()` Field by which records are sorted This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`int`	`hashCode()`
`void`	`setCursor(java.lang.String cursor)` Opaque cursor to be used for getting next page of records (supplied by current result page) This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setResultCount(java.lang.Long resultCount)` Count of results found (across all pages), set only on first page format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setSchema(java.lang.String schema)` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setSortAscending(java.lang.Boolean sortAscending)` If true, results are sorted in ascending order This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setSortBy(java.lang.String sortBy)` Field by which records are sorted This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - BaseRuleListResult
```
public BaseRuleListResult()
```
    Default constructor.
  - BaseRuleListResult
```
protected BaseRuleListResult(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLinks
```
public void setLinks(java.util.List<ResourceLink> links)
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    links - New value for the property.
  - getSchema
```
public java.lang.String getSchema()
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSchema
```
public void setSchema(java.lang.String schema)
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    schema - New value for the property.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getCursor
```
public java.lang.String getCursor()
```
    Opaque cursor to be used for getting next page of records (supplied by current result page) This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setCursor
```
public void setCursor(java.lang.String cursor)
```
    Opaque cursor to be used for getting next page of records (supplied by current result page) This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    cursor - New value for the property.
  - getResultCount
```
public java.lang.Long getResultCount()
```
    Count of results found (across all pages), set only on first page format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setResultCount
```
public void setResultCount(java.lang.Long resultCount)
```
    Count of results found (across all pages), set only on first page format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    resultCount - New value for the property.
  - getSortAscending
```
public java.lang.Boolean getSortAscending()
```
    If true, results are sorted in ascending order This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSortAscending
```
public void setSortAscending(java.lang.Boolean sortAscending)
```
    If true, results are sorted in ascending order This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    sortAscending - New value for the property.
  - getSortBy
```
public java.lang.String getSortBy()
```
    Field by which records are sorted This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSortBy
```
public void setSortBy(java.lang.String sortBy)
```
    Field by which records are sorted This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    sortBy - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static BaseRuleListResult _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static BaseRuleListResult _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class BaseRuleListResult

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

BaseRuleListResult

BaseRuleListResult

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getCursor

setCursor

getResultCount

setResultCount

getSortAscending

setSortAscending

getSortBy

setSortBy

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2