WindowsFirewallRule (odata-client-msgraph-beta 0.1.17 API)

java.lang.Object
- odata.msgraph.client.beta.complex.WindowsFirewallRule

All Implemented Interfaces:: com.github.davidmoten.odata.client.ODataType

public class WindowsFirewallRule
extends Object
implements com.github.davidmoten.odata.client.ODataType

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WindowsFirewallRule.Builder

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected StateManagementSetting`	`action`
`protected com.github.davidmoten.odata.client.ContextPath`	`contextPath`
`protected String`	`description`
`protected String`	`displayName`
`protected StateManagementSetting`	`edgeTraversal`
`protected String`	`filePath`
`protected WindowsFirewallRuleInterfaceTypes`	`interfaceTypes`
`protected List<String>`	`localAddressRanges`
`protected String`	`localAddressRangesNextLink`
`protected List<String>`	`localPortRanges`
`protected String`	`localPortRangesNextLink`
`protected String`	`localUserAuthorizations`
`protected String`	`odataType`
`protected String`	`packageFamilyName`
`protected WindowsFirewallRuleNetworkProfileTypes`	`profileTypes`
`protected Integer`	`protocol`
`protected List<String>`	`remoteAddressRanges`
`protected String`	`remoteAddressRangesNextLink`
`protected List<String>`	`remotePortRanges`
`protected String`	`remotePortRangesNextLink`
`protected String`	`serviceName`
`protected WindowsFirewallRuleTrafficDirectionType`	`trafficDirection`
`protected com.github.davidmoten.odata.client.internal.UnmappedFields`	`unmappedFields`

Constructor Summary

Constructors
Modifier Constructor and Description

protected WindowsFirewallRule()

Constructors
Modifier	Constructor and Description
`protected`	`WindowsFirewallRule()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static WindowsFirewallRule.Builder`	`builder()` Returns a builder which is used to create a new instance of this class (given that this class is immutable).
`Optional<StateManagementSetting>`	`getAction()` “The action the rule enforces.
`Optional<String>`	`getDescription()` “The description of the rule.”
`Optional<String>`	`getDisplayName()` “The display name of the rule.
`Optional<StateManagementSetting>`	`getEdgeTraversal()` “Indicates whether edge traversal is enabled or disabled for this rule.
`Optional<String>`	`getFilePath()` “The full file path of an app that's affected by the firewall rule.”
`Optional<WindowsFirewallRuleInterfaceTypes>`	`getInterfaceTypes()` “The interface types of the rule.”
`com.github.davidmoten.odata.client.CollectionPage<String>`	`getLocalAddressRanges()` “List of local addresses covered by the rule.
`com.github.davidmoten.odata.client.CollectionPage<String>`	`getLocalPortRanges()` “List of local port ranges.
`Optional<String>`	`getLocalUserAuthorizations()` “Specifies the list of authorized local users for the app container.
`Optional<String>`	`getPackageFamilyName()` “The package family name of a Microsoft Store application that's affected by the firewall rule.”
`Optional<WindowsFirewallRuleNetworkProfileTypes>`	`getProfileTypes()` “Specifies the profiles to which the rule belongs.
`Optional<Integer>`	`getProtocol()` “0-255 number representing the IP protocol (TCP = 6, UDP = 17).
`com.github.davidmoten.odata.client.CollectionPage<String>`	`getRemoteAddressRanges()` “List of tokens specifying the remote addresses covered by the rule.
`com.github.davidmoten.odata.client.CollectionPage<String>`	`getRemotePortRanges()` “List of remote port ranges.
`Optional<String>`	`getServiceName()` “The name used in cases when a service, not an application, is sending or receiving traffic.”
`Optional<WindowsFirewallRuleTrafficDirectionType>`	`getTrafficDirection()` “The traffic direction that the rule is enabled for.
`com.github.davidmoten.odata.client.internal.UnmappedFields`	`getUnmappedFields()`
`String`	`odataTypeName()`
`void`	`postInject(boolean addKeysToContextPath)`
`String`	`toString()`
`WindowsFirewallRule`	`withAction(StateManagementSetting action)` Returns an immutable copy of `this` with just the `action` field changed.
`WindowsFirewallRule`	`withDescription(String description)` Returns an immutable copy of `this` with just the `description` field changed.
`WindowsFirewallRule`	`withDisplayName(String displayName)` Returns an immutable copy of `this` with just the `displayName` field changed.
`WindowsFirewallRule`	`withEdgeTraversal(StateManagementSetting edgeTraversal)` Returns an immutable copy of `this` with just the `edgeTraversal` field changed.
`WindowsFirewallRule`	`withFilePath(String filePath)` Returns an immutable copy of `this` with just the `filePath` field changed.
`WindowsFirewallRule`	`withInterfaceTypes(WindowsFirewallRuleInterfaceTypes interfaceTypes)` Returns an immutable copy of `this` with just the `interfaceTypes` field changed.
`WindowsFirewallRule`	`withLocalUserAuthorizations(String localUserAuthorizations)` Returns an immutable copy of `this` with just the `localUserAuthorizations` field changed.
`WindowsFirewallRule`	`withPackageFamilyName(String packageFamilyName)` Returns an immutable copy of `this` with just the `packageFamilyName` field changed.
`WindowsFirewallRule`	`withProfileTypes(WindowsFirewallRuleNetworkProfileTypes profileTypes)` Returns an immutable copy of `this` with just the `profileTypes` field changed.
`WindowsFirewallRule`	`withProtocol(Integer protocol)` Returns an immutable copy of `this` with just the `protocol` field changed.
`WindowsFirewallRule`	`withServiceName(String serviceName)` Returns an immutable copy of `this` with just the `serviceName` field changed.
`WindowsFirewallRule`	`withTrafficDirection(WindowsFirewallRuleTrafficDirectionType trafficDirection)` Returns an immutable copy of `this` with just the `trafficDirection` field changed.

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

- Field Detail
  - contextPath
```
protected com.github.davidmoten.odata.client.ContextPath contextPath
```
  - unmappedFields
```
protected com.github.davidmoten.odata.client.internal.UnmappedFields unmappedFields
```
  - odataType
```
protected String odataType
```
  - displayName
```
protected String displayName
```
  - description
```
protected String description
```
  - packageFamilyName
```
protected String packageFamilyName
```
  - filePath
```
protected String filePath
```
  - serviceName
```
protected String serviceName
```
  - protocol
```
protected Integer protocol
```
  - localPortRanges
```
protected List<String> localPortRanges
```
  - localPortRangesNextLink
```
protected String localPortRangesNextLink
```
  - remotePortRanges
```
protected List<String> remotePortRanges
```
  - remotePortRangesNextLink
```
protected String remotePortRangesNextLink
```
  - localAddressRanges
```
protected List<String> localAddressRanges
```
  - localAddressRangesNextLink
```
protected String localAddressRangesNextLink
```
  - remoteAddressRanges
```
protected List<String> remoteAddressRanges
```
  - remoteAddressRangesNextLink
```
protected String remoteAddressRangesNextLink
```
  - profileTypes
```
protected WindowsFirewallRuleNetworkProfileTypes profileTypes
```
  - action
```
protected StateManagementSetting action
```
  - trafficDirection
```
protected WindowsFirewallRuleTrafficDirectionType trafficDirection
```
  - interfaceTypes
```
protected WindowsFirewallRuleInterfaceTypes interfaceTypes
```
  - edgeTraversal
```
protected StateManagementSetting edgeTraversal
```
  - localUserAuthorizations
```
protected String localUserAuthorizations
```
- Constructor Detail
  - WindowsFirewallRule
```
protected WindowsFirewallRule()
```
- Method Detail
  - odataTypeName
```
public String odataTypeName()
```
    Specified by:
    
    odataTypeName in interface com.github.davidmoten.odata.client.ODataType
  - getDisplayName
```
public Optional<String> getDisplayName()
```
    “The display name of the rule. Does not need to be unique.”
    
    Returns:
    
    property displayName
  - withDisplayName
```
public WindowsFirewallRule 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 display name of the rule. Does not need to be unique.”
    
    Parameters:
    
    displayName - new value of displayName field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the displayName field changed
  - getDescription
```
public Optional<String> getDescription()
```
    “The description of the rule.”
    
    Returns:
    
    property description
  - withDescription
```
public WindowsFirewallRule 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 description of the rule.”
    
    Parameters:
    
    description - new value of description field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the description field changed
  - getPackageFamilyName
```
public Optional<String> getPackageFamilyName()
```
    “The package family name of a Microsoft Store application that's affected by the firewall rule.”
    
    Returns:
    
    property packageFamilyName
  - withPackageFamilyName
```
public WindowsFirewallRule withPackageFamilyName(String packageFamilyName)
```
    Returns an immutable copy of this with just the packageFamilyName 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 package family name of a Microsoft Store application that's affected by the firewall rule.”
    
    Parameters:
    
    packageFamilyName - new value of packageFamilyName field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the packageFamilyName field changed
  - getFilePath
```
public Optional<String> getFilePath()
```
    “The full file path of an app that's affected by the firewall rule.”
    
    Returns:
    
    property filePath
  - withFilePath
```
public WindowsFirewallRule withFilePath(String filePath)
```
    Returns an immutable copy of this with just the filePath 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 full file path of an app that's affected by the firewall rule.”
    
    Parameters:
    
    filePath - new value of filePath field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the filePath field changed
  - getServiceName
```
public Optional<String> getServiceName()
```
    “The name used in cases when a service, not an application, is sending or receiving traffic.”
    
    Returns:
    
    property serviceName
  - withServiceName
```
public WindowsFirewallRule withServiceName(String serviceName)
```
    Returns an immutable copy of this with just the serviceName 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 name used in cases when a service, not an application, is sending or receiving traffic.”
    
    Parameters:
    
    serviceName - new value of serviceName field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the serviceName field changed
  - getProtocol
```
public Optional<Integer> getProtocol()
```
    “0-255 number representing the IP protocol (TCP = 6, UDP = 17). If not specified, the default is All. Valid values 0 to 255”
    
    Returns:
    
    property protocol
  - withProtocol
```
public WindowsFirewallRule withProtocol(Integer protocol)
```
    Returns an immutable copy of this with just the protocol 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.
    “0-255 number representing the IP protocol (TCP = 6, UDP = 17). If not specified, the default is All. Valid values 0 to 255”
    
    Parameters:
    
    protocol - new value of protocol field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the protocol field changed
  - getLocalPortRanges
```
public com.github.davidmoten.odata.client.CollectionPage<String> getLocalPortRanges()
```
    “List of local port ranges. For example, "100-120", "200", "300-320". If not specified, the default is All.”
    
    Returns:
    
    property localPortRanges
  - getRemotePortRanges
```
public com.github.davidmoten.odata.client.CollectionPage<String> getRemotePortRanges()
```
    “List of remote port ranges. For example, "100-120", "200", "300-320". If not specified, the default is All.”
    
    Returns:
    
    property remotePortRanges
  - getLocalAddressRanges
```
public com.github.davidmoten.odata.client.CollectionPage<String> getLocalAddressRanges()
```
    “List of local addresses covered by the rule. Default is any address. Valid tokens include:<ul><li>"*" indicates any local address. If present, this must be the only token included.</li><li>A subnet can be specified using either the subnet mask or network prefix notation. If neither a subnet mask nor a network prefix is specified, the subnet mask defaults to 255.255.255.255.</li><li>A valid IPv6 address.</li><li>An IPv4 address range in the format of "start address - end address" with no spaces included.</li><li>An IPv6 address range in the format of "start address - end address" with no spaces included.</li></ul>”
    
    Returns:
    
    property localAddressRanges
  - getRemoteAddressRanges
```
public com.github.davidmoten.odata.client.CollectionPage<String> getRemoteAddressRanges()
```
    “List of tokens specifying the remote addresses covered by the rule. Tokens are case insensitive. Default is any address. Valid tokens include:<ul><li>"*" indicates any remote address. If present, this must be the only token included.< /li><li>"Defaultgateway"</li><li>"DHCP"</li><li>"DNS"</li><li>"WINS"</li><li>" Intranet" (supported on Windows versions 1809+)</li><li>"RmtIntranet" (supported on Windows versions 1809+)</li><li>"Internet" (supported on Windows versions 1809+)</li><li>"Ply2Renders" (supported on Windows versions 1809+)</li><li>" LocalSubnet" indicates any local address on the local subnet.</li><li>A subnet can be specified using either the subnet mask or network prefix notation. If neither a subnet mask nor a network prefix is specified, the subnet mask defaults to 255.255.255.255.</li><li>A valid IPv6 address.</li><li>An IPv4 address range in the format of "start address - end address" with no spaces included.</li><li>An IPv6 address range in the format of "start address - end address" with no spaces included.</li></ul>”
    
    Returns:
    
    property remoteAddressRanges
  - getProfileTypes
```
public Optional<WindowsFirewallRuleNetworkProfileTypes> getProfileTypes()
```
    “Specifies the profiles to which the rule belongs. If not specified, the default is All.”
    
    Returns:
    
    property profileTypes
  - withProfileTypes
```
public WindowsFirewallRule withProfileTypes(WindowsFirewallRuleNetworkProfileTypes profileTypes)
```
    Returns an immutable copy of this with just the profileTypes 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.
    “Specifies the profiles to which the rule belongs. If not specified, the default is All.”
    
    Parameters:
    
    profileTypes - new value of profileTypes field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the profileTypes field changed
  - getAction
```
public Optional<StateManagementSetting> getAction()
```
    “The action the rule enforces. If not specified, the default is Allowed.”
    
    Returns:
    
    property action
  - withAction
```
public WindowsFirewallRule withAction(StateManagementSetting action)
```
    Returns an immutable copy of this with just the action 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 action the rule enforces. If not specified, the default is Allowed.”
    
    Parameters:
    
    action - new value of action field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the action field changed
  - getTrafficDirection
```
public Optional<WindowsFirewallRuleTrafficDirectionType> getTrafficDirection()
```
    “The traffic direction that the rule is enabled for. If not specified, the default is Out.”
    
    Returns:
    
    property trafficDirection
  - withTrafficDirection
```
public WindowsFirewallRule withTrafficDirection(WindowsFirewallRuleTrafficDirectionType trafficDirection)
```
    Returns an immutable copy of this with just the trafficDirection 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 traffic direction that the rule is enabled for. If not specified, the default is Out.”
    
    Parameters:
    
    trafficDirection - new value of trafficDirection field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the trafficDirection field changed
  - getInterfaceTypes
```
public Optional<WindowsFirewallRuleInterfaceTypes> getInterfaceTypes()
```
    “The interface types of the rule.”
    
    Returns:
    
    property interfaceTypes
  - withInterfaceTypes
```
public WindowsFirewallRule withInterfaceTypes(WindowsFirewallRuleInterfaceTypes interfaceTypes)
```
    Returns an immutable copy of this with just the interfaceTypes 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 interface types of the rule.”
    
    Parameters:
    
    interfaceTypes - new value of interfaceTypes field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the interfaceTypes field changed
  - getEdgeTraversal
```
public Optional<StateManagementSetting> getEdgeTraversal()
```
    “Indicates whether edge traversal is enabled or disabled for this rule. The EdgeTraversal setting indicates that specific inbound traffic is allowed to tunnel through NATs and other edge devices using the Teredo tunneling technology . In order for this setting to work correctly, the application or service with the inbound firewall rule needs to support IPv6. The primary application of this setting allows listeners on the host to be globally addressable through a Teredo IPv6 address. New rules have the EdgeTraversal property disabled by default.”
    
    Returns:
    
    property edgeTraversal
  - withEdgeTraversal
```
public WindowsFirewallRule withEdgeTraversal(StateManagementSetting edgeTraversal)
```
    Returns an immutable copy of this with just the edgeTraversal 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.
    “Indicates whether edge traversal is enabled or disabled for this rule. The EdgeTraversal setting indicates that specific inbound traffic is allowed to tunnel through NATs and other edge devices using the Teredo tunneling technology . In order for this setting to work correctly, the application or service with the inbound firewall rule needs to support IPv6. The primary application of this setting allows listeners on the host to be globally addressable through a Teredo IPv6 address. New rules have the EdgeTraversal property disabled by default.”
    
    Parameters:
    
    edgeTraversal - new value of edgeTraversal field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the edgeTraversal field changed
  - getLocalUserAuthorizations
```
public Optional<String> getLocalUserAuthorizations()
```
    “Specifies the list of authorized local users for the app container. This is a string in Security Descriptor Definition Language (SDDL) format.”
    
    Returns:
    
    property localUserAuthorizations
  - withLocalUserAuthorizations
```
public WindowsFirewallRule withLocalUserAuthorizations(String localUserAuthorizations)
```
    Returns an immutable copy of this with just the localUserAuthorizations 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.
    “Specifies the list of authorized local users for the app container. This is a string in Security Descriptor Definition Language (SDDL) format.”
    
    Parameters:
    
    localUserAuthorizations - new value of localUserAuthorizations field (as defined in service metadata)
    
    Returns:
    
    immutable copy of this with just the localUserAuthorizations field changed
  - getUnmappedFields
```
public com.github.davidmoten.odata.client.internal.UnmappedFields getUnmappedFields()
```
    Specified by:
    
    getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
  - postInject
```
public void postInject(boolean addKeysToContextPath)
```
    Specified by:
    
    postInject in interface com.github.davidmoten.odata.client.ODataType
  - builder
```
public static WindowsFirewallRule.Builder builder()
```
    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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WindowsFirewallRule

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

contextPath

unmappedFields

odataType

displayName

description

packageFamilyName

filePath

serviceName

protocol

localPortRanges

localPortRangesNextLink

remotePortRanges

remotePortRangesNextLink

localAddressRanges

localAddressRangesNextLink

remoteAddressRanges

remoteAddressRangesNextLink

profileTypes

action

trafficDirection

interfaceTypes

edgeTraversal

localUserAuthorizations

Constructor Detail

WindowsFirewallRule

Method Detail

odataTypeName

getDisplayName

withDisplayName

getDescription

withDescription

getPackageFamilyName

withPackageFamilyName

getFilePath

withFilePath

getServiceName

withServiceName

getProtocol

withProtocol

getLocalPortRanges

getRemotePortRanges

getLocalAddressRanges

getRemoteAddressRanges

getProfileTypes

withProfileTypes

getAction

withAction

getTrafficDirection

withTrafficDirection

getInterfaceTypes

withInterfaceTypes

getEdgeTraversal

withEdgeTraversal

getLocalUserAuthorizations

withLocalUserAuthorizations

getUnmappedFields

postInject

builder

toString