Firewall.Builder (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.Firewall.Builder

Enclosing class:: Firewall

public static class Firewall.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Firewall.Builder`	`addAllAllowed(List<Allowed> allowed)` The list of ALLOW rules specified by this firewall.
`Firewall.Builder`	`addAllDenied(List<Denied> denied)` The list of DENY rules specified by this firewall.
`Firewall.Builder`	`addAllDestinationRanges(List<String> destinationRanges)` If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges.
`Firewall.Builder`	`addAllowed(Allowed allowed)` The list of ALLOW rules specified by this firewall.
`Firewall.Builder`	`addAllSourceRanges(List<String> sourceRanges)` If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges.
`Firewall.Builder`	`addAllSourceServiceAccounts(List<String> sourceServiceAccounts)` If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list.
`Firewall.Builder`	`addAllSourceTags(List<String> sourceTags)` If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network.
`Firewall.Builder`	`addAllTargetServiceAccounts(List<String> targetServiceAccounts)` A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[].
`Firewall.Builder`	`addAllTargetTags(List<String> targetTags)` A list of tags that controls which instances the firewall rule applies to.
`Firewall.Builder`	`addDenied(Denied denied)` The list of DENY rules specified by this firewall.
`Firewall.Builder`	`addDestinationRanges(String destinationRanges)` If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges.
`Firewall.Builder`	`addSourceRanges(String sourceRanges)` If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges.
`Firewall.Builder`	`addSourceServiceAccounts(String sourceServiceAccounts)` If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list.
`Firewall.Builder`	`addSourceTags(String sourceTags)` If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network.
`Firewall.Builder`	`addTargetServiceAccounts(String targetServiceAccounts)` A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[].
`Firewall.Builder`	`addTargetTags(String targetTags)` A list of tags that controls which instances the firewall rule applies to.
`Firewall`	`build()`
`Firewall.Builder`	`clone()`
`List<Allowed>`	`getAllowedList()` The list of ALLOW rules specified by this firewall.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`List<Denied>`	`getDeniedList()` The list of DENY rules specified by this firewall.
`String`	`getDescription()` An optional description of this resource.
`List<String>`	`getDestinationRangesList()` If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges.
`String`	`getDirection()` Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`.
`Boolean`	`getDisabled()` Denotes whether the firewall rule is disabled.
`String`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getKind()` [Output Only] Type of the resource.
`FirewallLogConfig`	`getLogConfig()` This field denotes the logging options for a particular firewall rule.
`String`	`getName()` Name of the resource; provided by the client when the resource is created.
`String`	`getNetwork()` URL of the network resource for this firewall rule.
`Integer`	`getPriority()` Priority for this rule.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`List<String>`	`getSourceRangesList()` If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges.
`List<String>`	`getSourceServiceAccountsList()` If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list.
`List<String>`	`getSourceTagsList()` If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network.
`List<String>`	`getTargetServiceAccountsList()` A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[].
`List<String>`	`getTargetTagsList()` A list of tags that controls which instances the firewall rule applies to.
`Firewall.Builder`	`mergeFrom(Firewall other)`
`Firewall.Builder`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Firewall.Builder`	`setDescription(String description)` An optional description of this resource.
`Firewall.Builder`	`setDirection(String direction)` Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`.
`Firewall.Builder`	`setDisabled(Boolean disabled)` Denotes whether the firewall rule is disabled.
`Firewall.Builder`	`setId(String id)` [Output Only] The unique identifier for the resource.
`Firewall.Builder`	`setKind(String kind)` [Output Only] Type of the resource.
`Firewall.Builder`	`setLogConfig(FirewallLogConfig logConfig)` This field denotes the logging options for a particular firewall rule.
`Firewall.Builder`	`setName(String name)` Name of the resource; provided by the client when the resource is created.
`Firewall.Builder`	`setNetwork(String network)` URL of the network resource for this firewall rule.
`Firewall.Builder`	`setPriority(Integer priority)` Priority for this rule.
`Firewall.Builder`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.

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

- Method Detail
  - mergeFrom
```
public Firewall.Builder mergeFrom(Firewall other)
```
  - getAllowedList
```
public List<Allowed> getAllowedList()
```
    The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
  - addAllAllowed
```
public Firewall.Builder addAllAllowed(List<Allowed> allowed)
```
    The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
  - addAllowed
```
public Firewall.Builder addAllowed(Allowed allowed)
```
    The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - setCreationTimestamp
```
public Firewall.Builder setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - getDeniedList
```
public List<Denied> getDeniedList()
```
    The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
  - addAllDenied
```
public Firewall.Builder addAllDenied(List<Denied> denied)
```
    The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
  - addDenied
```
public Firewall.Builder addDenied(Denied denied)
```
    The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this field when you create the resource.
  - setDescription
```
public Firewall.Builder setDescription(String description)
```
    An optional description of this resource. Provide this field when you create the resource.
  - getDestinationRangesList
```
public List<String> getDestinationRangesList()
```
    If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
  - addAllDestinationRanges
```
public Firewall.Builder addAllDestinationRanges(List<String> destinationRanges)
```
    If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
  - addDestinationRanges
```
public Firewall.Builder addDestinationRanges(String destinationRanges)
```
    If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
  - getDirection
```
public String getDirection()
```
    Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.
  - setDirection
```
public Firewall.Builder setDirection(String direction)
```
    Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.
  - getDisabled
```
public Boolean getDisabled()
```
    Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.
  - setDisabled
```
public Firewall.Builder setDisabled(Boolean disabled)
```
    Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.
  - getId
```
public String getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - setId
```
public Firewall.Builder setId(String id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#firewall for firewall rules.
  - setKind
```
public Firewall.Builder setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#firewall for firewall rules.
  - getLogConfig
```
public FirewallLogConfig getLogConfig()
```
    This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.
  - setLogConfig
```
public Firewall.Builder setLogConfig(FirewallLogConfig logConfig)
```
    This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.
  - getName
```
public String getName()
```
    Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
  - setName
```
public Firewall.Builder setName(String name)
```
    Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
  - getNetwork
```
public String getNetwork()
```
    URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default
  - setNetwork
```
public Firewall.Builder setNetwork(String network)
```
    URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default
  - getPriority
```
public Integer getPriority()
```
    Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.
  - setPriority
```
public Firewall.Builder setPriority(Integer priority)
```
    Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
  - setSelfLink
```
public Firewall.Builder setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
  - getSourceRangesList
```
public List<String> getSourceRangesList()
```
    If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.
  - addAllSourceRanges
```
public Firewall.Builder addAllSourceRanges(List<String> sourceRanges)
```
    If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.
  - addSourceRanges
```
public Firewall.Builder addSourceRanges(String sourceRanges)
```
    If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.
  - getSourceServiceAccountsList
```
public List<String> getSourceServiceAccountsList()
```
    If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
  - addAllSourceServiceAccounts
```
public Firewall.Builder addAllSourceServiceAccounts(List<String> sourceServiceAccounts)
```
    If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
  - addSourceServiceAccounts
```
public Firewall.Builder addSourceServiceAccounts(String sourceServiceAccounts)
```
    If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
  - getSourceTagsList
```
public List<String> getSourceTagsList()
```
    If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.
  - addAllSourceTags
```
public Firewall.Builder addAllSourceTags(List<String> sourceTags)
```
    If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.
  - addSourceTags
```
public Firewall.Builder addSourceTags(String sourceTags)
```
    If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.
  - getTargetServiceAccountsList
```
public List<String> getTargetServiceAccountsList()
```
    A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
  - addAllTargetServiceAccounts
```
public Firewall.Builder addAllTargetServiceAccounts(List<String> targetServiceAccounts)
```
    A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
  - addTargetServiceAccounts
```
public Firewall.Builder addTargetServiceAccounts(String targetServiceAccounts)
```
    A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
  - getTargetTagsList
```
public List<String> getTargetTagsList()
```
    A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
  - addAllTargetTags
```
public Firewall.Builder addAllTargetTags(List<String> targetTags)
```
    A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
  - addTargetTags
```
public Firewall.Builder addTargetTags(String targetTags)
```
    A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
  - build
```
public Firewall build()
```
  - clone
```
public Firewall.Builder clone()
```
    Overrides:
    
    clone in class Object

Class Firewall.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

mergeFrom

getAllowedList

addAllAllowed

addAllowed

getCreationTimestamp

setCreationTimestamp

getDeniedList

addAllDenied

addDenied

getDescription

setDescription

getDestinationRangesList

addAllDestinationRanges

addDestinationRanges

getDirection

setDirection

getDisabled

setDisabled

getId

setId

getKind

setKind

getLogConfig

setLogConfig

getName

setName

getNetwork

setNetwork

getPriority

setPriority

getSelfLink

setSelfLink

getSourceRangesList

addAllSourceRanges

addSourceRanges

getSourceServiceAccountsList

addAllSourceServiceAccounts

addSourceServiceAccounts

getSourceTagsList

addAllSourceTags

addSourceTags

getTargetServiceAccountsList

addAllTargetServiceAccounts

addTargetServiceAccounts

getTargetTagsList

addAllTargetTags

addTargetTags

build

clone