Class RoleBinding

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

    public final class RoleBinding
    extends java.lang.Object
    implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    User/Group's role binding
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        RoleBinding()
      Default constructor.
      protected RoleBinding​(com.vmware.vapi.data.StructValue __dynamicStructureFields)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method 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 RoleBinding _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 RoleBinding _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.Long getCreateTime()
      Timestamp of resource creation 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 getCreateUser()
      ID of the user who created 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.
      java.lang.String getDescription()
      Description of this resource
      java.lang.String getDisplayName()
      Defaults to ID if not set
      java.lang.String getId()
      Unique identifier of this resource
      java.lang.String getIdentitySourceId()
      The ID of the external identity source that holds the referenced external entity.
      java.lang.String getIdentitySourceType()
      java.lang.Long getLastModifiedTime()
      Timestamp of last modification 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 getLastModifiedUser()
      ID of the user who last modified 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.
      java.util.List<ResourceLink> getLinks()
      The server will populate this field when returing the resource.
      java.lang.String getName()
      User/Group's name 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 getProtection()
      Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
      java.lang.Boolean getReadRolesForPaths()
      Set this property to true to cause the user's role definition to be read from the roles_for_paths property.
      java.lang.String getResourceType()
      The type of this resource.
      java.lang.Long getRevision()
      The _revision property describes the current revision of the resource.
      java.util.List<Role> getRoles()
      Deprecated.
      java.util.List<RolesForPath> getRolesForPaths()
      The roles that are associated with the user, limiting them to a path.
      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.String getStale()
      Possible values are: STALE_TRUE STALE_FALSE STALE_UNKNOWN Property 'stale' can be considered to have these values - absent - This type of rolebinding does not support stale property TRUE - Rolebinding is stale in vIDM meaning the user is no longer present in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - Rolebinding's state of staleness in unknown Once rolebindings become stale, they can be deleted using the API POST /aaa/role-bindings?action=delete_stale_bindings 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.Boolean getSystemOwned()
      Indicates system owned 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.
      java.util.List<Tag> getTags()
      Opaque identifiers meaningful to the API user
      java.lang.String getType()
      Possible values are: TYPE_REMOTE_USER TYPE_REMOTE_GROUP TYPE_LOCAL_USER TYPE_PRINCIPAL_IDENTITY TYPE_REMOTE Indicates the type of the user.
      java.lang.String getUserId()
      Local user's numeric id on the system.
      int hashCode()  
      void setCreateTime​(java.lang.Long createTime)
      Timestamp of resource creation 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 setCreateUser​(java.lang.String createUser)
      ID of the user who created 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 setDescription​(java.lang.String description)
      Description of this resource
      void setDisplayName​(java.lang.String displayName)
      Defaults to ID if not set
      void setId​(java.lang.String id)
      Unique identifier of this resource
      void setIdentitySourceId​(java.lang.String identitySourceId)
      The ID of the external identity source that holds the referenced external entity.
      void setIdentitySourceType​(java.lang.String identitySourceType)
      void setLastModifiedTime​(java.lang.Long lastModifiedTime)
      Timestamp of last modification 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 setLastModifiedUser​(java.lang.String lastModifiedUser)
      ID of the user who last modified 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 setLinks​(java.util.List<ResourceLink> links)
      The server will populate this field when returing the resource.
      void setName​(java.lang.String name)
      User/Group's name 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 setProtection​(java.lang.String protection)
      Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
      void setReadRolesForPaths​(java.lang.Boolean readRolesForPaths)
      Set this property to true to cause the user's role definition to be read from the roles_for_paths property.
      void setResourceType​(java.lang.String resourceType)
      The type of this resource.
      void setRevision​(java.lang.Long revision)
      The _revision property describes the current revision of the resource.
      void setRoles​(java.util.List<Role> roles)
      Deprecated.
      void setRolesForPaths​(java.util.List<RolesForPath> rolesForPaths)
      The roles that are associated with the user, limiting them to a path.
      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 setStale​(java.lang.String stale)
      Possible values are: STALE_TRUE STALE_FALSE STALE_UNKNOWN Property 'stale' can be considered to have these values - absent - This type of rolebinding does not support stale property TRUE - Rolebinding is stale in vIDM meaning the user is no longer present in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - Rolebinding's state of staleness in unknown Once rolebindings become stale, they can be deleted using the API POST /aaa/role-bindings?action=delete_stale_bindings 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 setSystemOwned​(java.lang.Boolean systemOwned)
      Indicates system owned 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 setTags​(java.util.List<Tag> tags)
      Opaque identifiers meaningful to the API user
      void setType​(java.lang.String type)
      Possible values are: TYPE_REMOTE_USER TYPE_REMOTE_GROUP TYPE_LOCAL_USER TYPE_PRINCIPAL_IDENTITY TYPE_REMOTE Indicates the type of the user.
      void setUserId​(java.lang.String userId)
      Local user's numeric id on the system.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • IDENTITY_SOURCE_TYPE_VIDM

        public static final java.lang.String IDENTITY_SOURCE_TYPE_VIDM
        See Also:
        Constant Field Values
      • IDENTITY_SOURCE_TYPE_LDAP

        public static final java.lang.String IDENTITY_SOURCE_TYPE_LDAP
        See Also:
        Constant Field Values
      • IDENTITY_SOURCE_TYPE_OIDC

        public static final java.lang.String IDENTITY_SOURCE_TYPE_OIDC
        See Also:
        Constant Field Values
      • IDENTITY_SOURCE_TYPE_CSP

        public static final java.lang.String IDENTITY_SOURCE_TYPE_CSP
        See Also:
        Constant Field Values
      • TYPE_REMOTE_USER

        public static final java.lang.String TYPE_REMOTE_USER
        See Also:
        Constant Field Values
      • TYPE_REMOTE_GROUP

        public static final java.lang.String TYPE_REMOTE_GROUP
        See Also:
        Constant Field Values
      • TYPE_PRINCIPAL_IDENTITY

        public static final java.lang.String TYPE_PRINCIPAL_IDENTITY
        See Also:
        Constant Field Values
      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields
    • Constructor Detail

      • RoleBinding

        public RoleBinding()
        Default constructor.
      • RoleBinding

        protected RoleBinding​(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.
      • getRevision

        public java.lang.Long getRevision()
        The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
        Returns:
        The current value of the property.
      • setRevision

        public void setRevision​(java.lang.Long revision)
        The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
        Parameters:
        revision - New value for the property.
      • getCreateTime

        public java.lang.Long getCreateTime()
        Timestamp of resource creation 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.
      • setCreateTime

        public void setCreateTime​(java.lang.Long createTime)
        Timestamp of resource creation 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:
        createTime - New value for the property.
      • getCreateUser

        public java.lang.String getCreateUser()
        ID of the user who created 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.
      • setCreateUser

        public void setCreateUser​(java.lang.String createUser)
        ID of the user who created 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:
        createUser - New value for the property.
      • getLastModifiedTime

        public java.lang.Long getLastModifiedTime()
        Timestamp of last modification 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.
      • setLastModifiedTime

        public void setLastModifiedTime​(java.lang.Long lastModifiedTime)
        Timestamp of last modification 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:
        lastModifiedTime - New value for the property.
      • getLastModifiedUser

        public java.lang.String getLastModifiedUser()
        ID of the user who last modified 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.
      • setLastModifiedUser

        public void setLastModifiedUser​(java.lang.String lastModifiedUser)
        ID of the user who last modified 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:
        lastModifiedUser - New value for the property.
      • getProtection

        public java.lang.String getProtection()
        Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. 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.
      • setProtection

        public void setProtection​(java.lang.String protection)
        Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. 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:
        protection - New value for the property.
      • getSystemOwned

        public java.lang.Boolean getSystemOwned()
        Indicates system owned 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.
      • setSystemOwned

        public void setSystemOwned​(java.lang.Boolean systemOwned)
        Indicates system owned 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:
        systemOwned - New value for the property.
      • getDescription

        public java.lang.String getDescription()
        Description of this resource
        Returns:
        The current value of the property.
      • setDescription

        public void setDescription​(java.lang.String description)
        Description of this resource
        Parameters:
        description - New value for the property.
      • getDisplayName

        public java.lang.String getDisplayName()
        Defaults to ID if not set
        Returns:
        The current value of the property.
      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        Defaults to ID if not set
        Parameters:
        displayName - New value for the property.
      • getId

        public java.lang.String getId()
        Unique identifier of this resource
        Returns:
        The current value of the property.
      • setId

        public void setId​(java.lang.String id)
        Unique identifier of this resource
        Parameters:
        id - New value for the property.
      • getResourceType

        public java.lang.String getResourceType()
        The type of this resource.
        Returns:
        The current value of the property.
      • setResourceType

        public void setResourceType​(java.lang.String resourceType)
        The type of this resource.
        Parameters:
        resourceType - New value for the property.
      • getTags

        public java.util.List<Tag> getTags()
        Opaque identifiers meaningful to the API user
        Returns:
        The current value of the property.
      • setTags

        public void setTags​(java.util.List<Tag> tags)
        Opaque identifiers meaningful to the API user
        Parameters:
        tags - New value for the property.
      • getIdentitySourceId

        public java.lang.String getIdentitySourceId()
        The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
        Returns:
        The current value of the property.
      • setIdentitySourceId

        public void setIdentitySourceId​(java.lang.String identitySourceId)
        The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
        Parameters:
        identitySourceId - New value for the property.
      • getName

        public java.lang.String getName()
        User/Group's name 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.
      • setName

        public void setName​(java.lang.String name)
        User/Group's name 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:
        name - New value for the property.
      • getReadRolesForPaths

        public java.lang.Boolean getReadRolesForPaths()
        Set this property to true to cause the user's role definition to be read from the roles_for_paths property. Set it to false to cause the user's role definition to be read from the roles property.
        Returns:
        The current value of the property.
      • setReadRolesForPaths

        public void setReadRolesForPaths​(java.lang.Boolean readRolesForPaths)
        Set this property to true to cause the user's role definition to be read from the roles_for_paths property. Set it to false to cause the user's role definition to be read from the roles property.
        Parameters:
        readRolesForPaths - New value for the property.
      • getRoles

        @Deprecated
        public java.util.List<Role> getRoles()
        Deprecated.
        Roles 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.
      • setRoles

        @Deprecated
        public void setRoles​(java.util.List<Role> roles)
        Deprecated.
        Roles 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:
        roles - New value for the property.
      • getRolesForPaths

        public java.util.List<RolesForPath> getRolesForPaths()
        The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere i.e. it is same as the deprecated property roles.
        Returns:
        The current value of the property.
      • setRolesForPaths

        public void setRolesForPaths​(java.util.List<RolesForPath> rolesForPaths)
        The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere i.e. it is same as the deprecated property roles.
        Parameters:
        rolesForPaths - New value for the property.
      • getStale

        public java.lang.String getStale()
        Possible values are: Property 'stale' can be considered to have these values - absent - This type of rolebinding does not support stale property TRUE - Rolebinding is stale in vIDM meaning the user is no longer present in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - Rolebinding's state of staleness in unknown Once rolebindings become stale, they can be deleted using the API POST /aaa/role-bindings?action=delete_stale_bindings 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.
      • setStale

        public void setStale​(java.lang.String stale)
        Possible values are: Property 'stale' can be considered to have these values - absent - This type of rolebinding does not support stale property TRUE - Rolebinding is stale in vIDM meaning the user is no longer present in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - Rolebinding's state of staleness in unknown Once rolebindings become stale, they can be deleted using the API POST /aaa/role-bindings?action=delete_stale_bindings 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:
        stale - New value for the property.
      • getType

        public java.lang.String getType()
        Possible values are: Indicates the type of the user. remote_user - This is a user which is external to NSX. remote_group - This is a group of users which is external to NSX. local_user - This is a user local to NSX. These are linux users. principal_identity - This is a principal identity user. remote - The the principal is remote but whether it is a user or group is not known. Currently this is applicable only to LDAP identity_source_type. 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.
      • setType

        public void setType​(java.lang.String type)
        Possible values are: Indicates the type of the user. remote_user - This is a user which is external to NSX. remote_group - This is a group of users which is external to NSX. local_user - This is a user local to NSX. These are linux users. principal_identity - This is a principal identity user. remote - The the principal is remote but whether it is a user or group is not known. Currently this is applicable only to LDAP identity_source_type. 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:
        type - New value for the property.
      • getUserId

        public java.lang.String getUserId()
        Local user's numeric id on the system. 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.
      • setUserId

        public void setUserId​(java.lang.String userId)
        Local user's numeric id on the system. 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:
        userId - 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 RoleBinding _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 RoleBinding _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.