Class MicrosoftTunnelSite

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType

    public class MicrosoftTunnelSite
    extends Entity
    implements com.github.davidmoten.odata.client.ODataEntityType
    “Entity that represents a Microsoft Tunnel site”
    • Field Detail

      • description

        protected String description
      • displayName

        protected String displayName
      • internalNetworkProbeUrl

        protected String internalNetworkProbeUrl
      • publicAddress

        protected String publicAddress
      • roleScopeTagIds

        protected List<String> roleScopeTagIds
      • roleScopeTagIdsNextLink

        protected String roleScopeTagIdsNextLink
      • upgradeAutomatically

        protected Boolean upgradeAutomatically
      • upgradeAvailable

        protected Boolean upgradeAvailable
      • upgradeWindowEndTime

        protected LocalTime upgradeWindowEndTime
      • upgradeWindowStartTime

        protected LocalTime upgradeWindowStartTime
      • upgradeWindowUtcOffsetInMinutes

        protected Integer upgradeWindowUtcOffsetInMinutes
    • Constructor Detail

      • MicrosoftTunnelSite

        protected MicrosoftTunnelSite()
    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        odataTypeName in class Entity
      • builderMicrosoftTunnelSite

        public static MicrosoftTunnelSite.Builder builderMicrosoftTunnelSite()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class
      • getChangedFields

        public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
        Specified by:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class Entity
      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class Entity
      • getDescription

        public Optional<String> getDescription()
        “The MicrosoftTunnelSite's description”
        Returns:
        property description
      • withDescription

        public MicrosoftTunnelSite withDescription​(String description)
        Returns an immutable copy of this with just the description field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The MicrosoftTunnelSite's description”

        Parameters:
        description - new value of description field (as defined in service metadata)
        Returns:
        immutable copy of this with just the description field changed
      • getDisplayName

        public Optional<String> getDisplayName()
        “The MicrosoftTunnelSite's display name”
        Returns:
        property displayName
      • withDisplayName

        public MicrosoftTunnelSite withDisplayName​(String displayName)
        Returns an immutable copy of this with just the displayName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The MicrosoftTunnelSite's display name”

        Parameters:
        displayName - new value of displayName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the displayName field changed
      • getInternalNetworkProbeUrl

        public Optional<String> getInternalNetworkProbeUrl()
        “The MicrosoftTunnelSite's Internal Network Access Probe URL”
        Returns:
        property internalNetworkProbeUrl
      • withInternalNetworkProbeUrl

        public MicrosoftTunnelSite withInternalNetworkProbeUrl​(String internalNetworkProbeUrl)
        Returns an immutable copy of this with just the internalNetworkProbeUrl field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The MicrosoftTunnelSite's Internal Network Access Probe URL”

        Parameters:
        internalNetworkProbeUrl - new value of internalNetworkProbeUrl field (as defined in service metadata)
        Returns:
        immutable copy of this with just the internalNetworkProbeUrl field changed
      • getPublicAddress

        public Optional<String> getPublicAddress()
        “The MicrosoftTunnelSite's public domain name or IP address”
        Returns:
        property publicAddress
      • withPublicAddress

        public MicrosoftTunnelSite withPublicAddress​(String publicAddress)
        Returns an immutable copy of this with just the publicAddress field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The MicrosoftTunnelSite's public domain name or IP address”

        Parameters:
        publicAddress - new value of publicAddress field (as defined in service metadata)
        Returns:
        immutable copy of this with just the publicAddress field changed
      • getRoleScopeTagIds

        public com.github.davidmoten.odata.client.CollectionPage<String> getRoleScopeTagIds()
        “List of Scope Tags for this Entity instance.”
        Returns:
        property roleScopeTagIds
      • withRoleScopeTagIds

        public MicrosoftTunnelSite withRoleScopeTagIds​(List<String> roleScopeTagIds)
        Returns an immutable copy of this with just the roleScopeTagIds field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “List of Scope Tags for this Entity instance.”

        Parameters:
        roleScopeTagIds - new value of roleScopeTagIds field (as defined in service metadata)
        Returns:
        immutable copy of this with just the roleScopeTagIds field changed
      • getRoleScopeTagIds

        public com.github.davidmoten.odata.client.CollectionPage<String> getRoleScopeTagIds​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “List of Scope Tags for this Entity instance.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property roleScopeTagIds
      • getUpgradeAutomatically

        public Optional<Boolean> getUpgradeAutomatically()
        “The site's automatic upgrade setting. True for automatic upgrades, false for manual control”
        Returns:
        property upgradeAutomatically
      • withUpgradeAutomatically

        public MicrosoftTunnelSite withUpgradeAutomatically​(Boolean upgradeAutomatically)
        Returns an immutable copy of this with just the upgradeAutomatically field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The site's automatic upgrade setting. True for automatic upgrades, false for manual control”

        Parameters:
        upgradeAutomatically - new value of upgradeAutomatically field (as defined in service metadata)
        Returns:
        immutable copy of this with just the upgradeAutomatically field changed
      • getUpgradeAvailable

        public Optional<Boolean> getUpgradeAvailable()
        “True if an upgrade is available”
        Returns:
        property upgradeAvailable
      • withUpgradeAvailable

        public MicrosoftTunnelSite withUpgradeAvailable​(Boolean upgradeAvailable)
        Returns an immutable copy of this with just the upgradeAvailable field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “True if an upgrade is available”

        Parameters:
        upgradeAvailable - new value of upgradeAvailable field (as defined in service metadata)
        Returns:
        immutable copy of this with just the upgradeAvailable field changed
      • getUpgradeWindowEndTime

        public Optional<LocalTime> getUpgradeWindowEndTime()
        “The site's upgrade window end time of day”
        Returns:
        property upgradeWindowEndTime
      • withUpgradeWindowEndTime

        public MicrosoftTunnelSite withUpgradeWindowEndTime​(LocalTime upgradeWindowEndTime)
        Returns an immutable copy of this with just the upgradeWindowEndTime field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The site's upgrade window end time of day”

        Parameters:
        upgradeWindowEndTime - new value of upgradeWindowEndTime field (as defined in service metadata)
        Returns:
        immutable copy of this with just the upgradeWindowEndTime field changed
      • getUpgradeWindowStartTime

        public Optional<LocalTime> getUpgradeWindowStartTime()
        “The site's upgrade window start time of day”
        Returns:
        property upgradeWindowStartTime
      • withUpgradeWindowStartTime

        public MicrosoftTunnelSite withUpgradeWindowStartTime​(LocalTime upgradeWindowStartTime)
        Returns an immutable copy of this with just the upgradeWindowStartTime field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The site's upgrade window start time of day”

        Parameters:
        upgradeWindowStartTime - new value of upgradeWindowStartTime field (as defined in service metadata)
        Returns:
        immutable copy of this with just the upgradeWindowStartTime field changed
      • getUpgradeWindowUtcOffsetInMinutes

        public Optional<Integer> getUpgradeWindowUtcOffsetInMinutes()
        “The site's timezone represented as a minute offset from UTC”
        Returns:
        property upgradeWindowUtcOffsetInMinutes
      • withUpgradeWindowUtcOffsetInMinutes

        public MicrosoftTunnelSite withUpgradeWindowUtcOffsetInMinutes​(Integer upgradeWindowUtcOffsetInMinutes)
        Returns an immutable copy of this with just the upgradeWindowUtcOffsetInMinutes field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The site's timezone represented as a minute offset from UTC”

        Parameters:
        upgradeWindowUtcOffsetInMinutes - new value of upgradeWindowUtcOffsetInMinutes field (as defined in service metadata)
        Returns:
        immutable copy of this with just the upgradeWindowUtcOffsetInMinutes field changed
      • getMicrosoftTunnelConfiguration

        public MicrosoftTunnelConfigurationRequest getMicrosoftTunnelConfiguration()
        “The MicrosoftTunnelConfiguration that has been applied to this MicrosoftTunnelSite”
        Returns:
        navigational property microsoftTunnelConfiguration
      • getMicrosoftTunnelServers

        public MicrosoftTunnelServerCollectionRequest getMicrosoftTunnelServers()
        “A list of MicrosoftTunnelServers that are registered to this MicrosoftTunnelSite”
        Returns:
        navigational property microsoftTunnelServers
      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class Entity
      • patch

        public MicrosoftTunnelSite patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class Entity
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
      • put

        public MicrosoftTunnelSite put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class Entity
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
      • requestUpgrade

        public com.github.davidmoten.odata.client.ActionRequestNoReturn requestUpgrade()