Copyright	(c) 2025
License	MIT
Maintainer
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Google.Cloud.Compute.Firewall

Description

This module provides a Haskell client for Google Cloud Compute Engine Firewall operations.

Synopsis

listFirewalls :: String -> Maybe ListFirewallsQuery -> IO (Either String FirewallList)
data FirewallList = FirewallList {
- kind :: Maybe String
- id :: Maybe String
- items :: Maybe [FirewallMeta]
- nextPageToken :: Maybe String
- selfLink :: Maybe String
- warning :: Maybe Warning
}
data FirewallMeta = FirewallMeta {
- kind :: Maybe String
- id :: Maybe String
- creationTimestamp :: Maybe String
- name :: Maybe String
- description :: Maybe String
- network :: Maybe String
- priority :: Maybe Int
- sourceRanges :: Maybe [String]
- sourceTags :: Maybe [String]
- targetTags :: Maybe [String]
- allowed :: Maybe [AllowedFirewall]
- denied :: Maybe [DeniedFirewall]
- direction :: Maybe String
- logConfig :: Maybe LogConfig
- disabled :: Maybe Bool
- selfLink :: Maybe String
}
data AllowedFirewall = AllowedFirewall {
- iPProtocol :: String
- ports :: Maybe [String]
}
createFirewall :: String -> CreateFirewallOps -> Maybe CreateFirewallQuery -> IO (Either String CreateFirewallResp)
data CreateFirewallOps = CreateFirewallOps {
- name :: String
- description :: Maybe String
- network :: Maybe String
- priority :: Maybe Int
- sourceRanges :: Maybe [String]
- sourceTags :: Maybe [String]
- targetTags :: Maybe [String]
- allowed :: Maybe [AllowedFirewall]
- denied :: Maybe [DeniedFirewall]
- direction :: Maybe String
- logConfig :: Maybe LogConfig
- disabled :: Maybe Bool
}
type CreateFirewallResp = Operation
data Operation = Operation {
- id :: Maybe String
- name :: Maybe String
- operationType :: Maybe String
- targetLink :: Maybe String
- status :: Maybe String
- progress :: Maybe Int
- insertTime :: Maybe String
- startTime :: Maybe String
- endTime :: Maybe String
- error_ :: Maybe OperationError
- warnings :: Maybe [Warning]
- selfLink :: Maybe String
}
data Warning = Warning {
- code :: String
- message :: String
- data_ :: Maybe [WarningData]
}
data WarningData = WarningData {
- key :: String
- value :: String
}
data LogConfig = LogConfig {
- enable :: Bool
- metadata :: Maybe String
}
data DeniedFirewall = DeniedFirewall {
- iPProtocol :: String
- ports :: Maybe [String]
}
defaultCreateFirewallOps :: String -> CreateFirewallOps

Documentation

listFirewalls Source #

Arguments

:: String	GCP Project ID
-> Maybe ListFirewallsQuery	Optional query parameters
-> IO (Either String FirewallList)	List result or error

List firewall rules in a project

Example:

listFirewalls "my-project" (Just ListFirewallsQuery { filter0 = Just "name=default-allow-*" })

data FirewallList Source #

Response format for firewall listing operations

Constructors

FirewallList
Fields kind :: Maybe String Type identifier ("compute#firewallList") id :: Maybe String Unique identifier for the resource items :: Maybe [FirewallMeta] List of firewall rules nextPageToken :: Maybe String Pagination token for next page selfLink :: Maybe String Server-defined URL for the resource warning :: Maybe Warning Any warnings about the result

Instances

Instances details

FromJSON FirewallList Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods parseJSON :: Value -> Parser FirewallList # parseJSONList :: Value -> Parser [FirewallList] # omittedField :: Maybe FirewallList #
ToJSON FirewallList Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods toJSON :: FirewallList -> Value # toEncoding :: FirewallList -> Encoding # toJSONList :: [FirewallList] -> Value # toEncodingList :: [FirewallList] -> Encoding # omitField :: FirewallList -> Bool #
Show FirewallList Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods showsPrec :: Int -> FirewallList -> ShowS # show :: FirewallList -> String # showList :: [FirewallList] -> ShowS #
Eq FirewallList Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods (==) :: FirewallList -> FirewallList -> Bool # (/=) :: FirewallList -> FirewallList -> Bool #

data FirewallMeta Source #

Represents a Google Cloud Firewall Rule

Constructors

FirewallMeta

Fields

kind :: Maybe String
Type identifier ("compute#firewall")
id :: Maybe String
Unique numeric ID
creationTimestamp :: Maybe String
ISO 8601 creation timestamp
name :: Maybe String
User-provided firewall name
description :: Maybe String
Optional rule description
network :: Maybe String
Network URL the rule applies to
priority :: Maybe Int
Rule priority (0-65535, lower=higher)
sourceRanges :: Maybe [String]
Allowed source IP ranges (CIDR)
sourceTags :: Maybe [String]
Source instance tags
targetTags :: Maybe [String]
Target instance tags
allowed :: Maybe [AllowedFirewall]
Allow rules
denied :: Maybe [DeniedFirewall]
Deny rules
direction :: Maybe String
Traffic direction (INGRESS/EGRESS)
logConfig :: Maybe LogConfig
Logging configuration
disabled :: Maybe Bool
Whether rule is disabled
selfLink :: Maybe String
Server-defined URL for the rule

Instances

Instances details

FromJSON FirewallMeta Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods parseJSON :: Value -> Parser FirewallMeta # parseJSONList :: Value -> Parser [FirewallMeta] # omittedField :: Maybe FirewallMeta #
ToJSON FirewallMeta Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods toJSON :: FirewallMeta -> Value # toEncoding :: FirewallMeta -> Encoding # toJSONList :: [FirewallMeta] -> Value # toEncodingList :: [FirewallMeta] -> Encoding # omitField :: FirewallMeta -> Bool #
Show FirewallMeta Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods showsPrec :: Int -> FirewallMeta -> ShowS # show :: FirewallMeta -> String # showList :: [FirewallMeta] -> ShowS #
Eq FirewallMeta Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods (==) :: FirewallMeta -> FirewallMeta -> Bool # (/=) :: FirewallMeta -> FirewallMeta -> Bool #

data AllowedFirewall Source #

Allow rule specification

Constructors

AllowedFirewall
Fields iPProtocol :: String Protocol name (e.g., "tcp", "udp", "icmp") ports :: Maybe [String] Optional port numbers/ranges (e.g., "80", "8000-8080")

Instances

Instances details

FromJSON AllowedFirewall Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods parseJSON :: Value -> Parser AllowedFirewall # parseJSONList :: Value -> Parser [AllowedFirewall] # omittedField :: Maybe AllowedFirewall #
ToJSON AllowedFirewall Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods toJSON :: AllowedFirewall -> Value # toEncoding :: AllowedFirewall -> Encoding # toJSONList :: [AllowedFirewall] -> Value # toEncodingList :: [AllowedFirewall] -> Encoding # omitField :: AllowedFirewall -> Bool #
Show AllowedFirewall Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods showsPrec :: Int -> AllowedFirewall -> ShowS # show :: AllowedFirewall -> String # showList :: [AllowedFirewall] -> ShowS #
Eq AllowedFirewall Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods (==) :: AllowedFirewall -> AllowedFirewall -> Bool # (/=) :: AllowedFirewall -> AllowedFirewall -> Bool #

createFirewall Source #

Arguments

:: String	GCP Project ID
-> CreateFirewallOps	Firewall configuration
-> Maybe CreateFirewallQuery	Optional request ID
-> IO (Either String CreateFirewallResp)	Operation or error

Create a new firewall rule

Example:

createFirewall "my-project"
  (defaultCreateFirewallOps "allow-http"
    { allowed = Just [AllowedFirewall "tcp" (Just ["80"])]
    , sourceRanges = Just ["0.0.0.0/0"]
  }) Nothing

data CreateFirewallOps Source #

Firewall creation options

Constructors

CreateFirewallOps

Fields

name :: String
Required firewall rule name
description :: Maybe String
Optional description
network :: Maybe String
Network URL (default: "globalnetworksdefault")
priority :: Maybe Int
Priority (default: 1000)
sourceRanges :: Maybe [String]
Source IP ranges (CIDR format)
sourceTags :: Maybe [String]
Source instance tags
targetTags :: Maybe [String]
Target instance tags
allowed :: Maybe [AllowedFirewall]
Traffic allow rules
denied :: Maybe [DeniedFirewall]
Traffic deny rules
direction :: Maybe String
Traffic direction (default: INGRESS)
logConfig :: Maybe LogConfig
Logging configuration
disabled :: Maybe Bool
Initial disabled state (default: False)

Instances

Instances details

ToJSON CreateFirewallOps Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods toJSON :: CreateFirewallOps -> Value # toEncoding :: CreateFirewallOps -> Encoding # toJSONList :: [CreateFirewallOps] -> Value # toEncodingList :: [CreateFirewallOps] -> Encoding # omitField :: CreateFirewallOps -> Bool #
Show CreateFirewallOps Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods showsPrec :: Int -> CreateFirewallOps -> ShowS # show :: CreateFirewallOps -> String # showList :: [CreateFirewallOps] -> ShowS #
Eq CreateFirewallOps Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods (==) :: CreateFirewallOps -> CreateFirewallOps -> Bool # (/=) :: CreateFirewallOps -> CreateFirewallOps -> Bool #

type CreateFirewallResp = Operation Source #

Alias for operation response from firewall creation

data Operation Source #

Long-running operation resource

Constructors

Operation

Fields

id :: Maybe String
Unique operation ID
name :: Maybe String
Operation name
operationType :: Maybe String
Operation type (insert, delete, etc.)
targetLink :: Maybe String
URL of resource being modified
status :: Maybe String
Current status (DONE, RUNNING, etc.)
progress :: Maybe Int
Operation progress (0-100)
insertTime :: Maybe String
ISO 8601 creation timestamp
startTime :: Maybe String
ISO 8601 start timestamp
endTime :: Maybe String
ISO 8601 completion timestamp
error_ :: Maybe OperationError
Error details if failed
warnings :: Maybe [Warning]
Warnings during operation
selfLink :: Maybe String
Server-defined URL for the operation

Instances

Instances details

FromJSON Operation Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods parseJSON :: Value -> Parser Operation # parseJSONList :: Value -> Parser [Operation] # omittedField :: Maybe Operation #
ToJSON Operation Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods toJSON :: Operation -> Value # toEncoding :: Operation -> Encoding # toJSONList :: [Operation] -> Value # toEncodingList :: [Operation] -> Encoding # omitField :: Operation -> Bool #
Show Operation Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods showsPrec :: Int -> Operation -> ShowS # show :: Operation -> String # showList :: [Operation] -> ShowS #
Eq Operation Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods (==) :: Operation -> Operation -> Bool # (/=) :: Operation -> Operation -> Bool #

data Warning Source #

Represents a warning object in API responses

Constructors

Warning
Fields code :: String Warning type identifier message :: String Human-readable warning message data_ :: Maybe [WarningData] Optional metadata about the warning

Instances

Instances details

FromJSON Warning Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods parseJSON :: Value -> Parser Warning # parseJSONList :: Value -> Parser [Warning] # omittedField :: Maybe Warning #
ToJSON Warning Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods toJSON :: Warning -> Value # toEncoding :: Warning -> Encoding # toJSONList :: [Warning] -> Value # toEncodingList :: [Warning] -> Encoding # omitField :: Warning -> Bool #
Show Warning Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods showsPrec :: Int -> Warning -> ShowS # show :: Warning -> String # showList :: [Warning] -> ShowS #
Eq Warning Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods (==) :: Warning -> Warning -> Bool # (/=) :: Warning -> Warning -> Bool #

data WarningData Source #

Key-value pair providing additional context for warnings

Constructors

WarningData
Fields key :: String Metadata key describing the warning aspect value :: String Metadata value associated with the key

Instances

Instances details

FromJSON WarningData Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods parseJSON :: Value -> Parser WarningData # parseJSONList :: Value -> Parser [WarningData] # omittedField :: Maybe WarningData #
ToJSON WarningData Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods toJSON :: WarningData -> Value # toEncoding :: WarningData -> Encoding # toJSONList :: [WarningData] -> Value # toEncodingList :: [WarningData] -> Encoding # omitField :: WarningData -> Bool #
Show WarningData Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods showsPrec :: Int -> WarningData -> ShowS # show :: WarningData -> String # showList :: [WarningData] -> ShowS #
Eq WarningData Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods (==) :: WarningData -> WarningData -> Bool # (/=) :: WarningData -> WarningData -> Bool #

data LogConfig Source #

Firewall rule logging configuration

Constructors

LogConfig
Fields enable :: Bool Whether to enable logging metadata :: Maybe String Log metadata level (EXCLUDE_ALL_METADATA or INCLUDE_ALL_METADATA)

Instances

Instances details

FromJSON LogConfig Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods parseJSON :: Value -> Parser LogConfig # parseJSONList :: Value -> Parser [LogConfig] # omittedField :: Maybe LogConfig #
ToJSON LogConfig Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods toJSON :: LogConfig -> Value # toEncoding :: LogConfig -> Encoding # toJSONList :: [LogConfig] -> Value # toEncodingList :: [LogConfig] -> Encoding # omitField :: LogConfig -> Bool #
Show LogConfig Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods showsPrec :: Int -> LogConfig -> ShowS # show :: LogConfig -> String # showList :: [LogConfig] -> ShowS #
Eq LogConfig Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods (==) :: LogConfig -> LogConfig -> Bool # (/=) :: LogConfig -> LogConfig -> Bool #

data DeniedFirewall Source #

Deny rule specification

Constructors

DeniedFirewall
Fields iPProtocol :: String Protocol name (e.g., "tcp", "udp") ports :: Maybe [String] Optional port numbers/ranges to block

Instances

Instances details

FromJSON DeniedFirewall Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods parseJSON :: Value -> Parser DeniedFirewall # parseJSONList :: Value -> Parser [DeniedFirewall] # omittedField :: Maybe DeniedFirewall #
ToJSON DeniedFirewall Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods toJSON :: DeniedFirewall -> Value # toEncoding :: DeniedFirewall -> Encoding # toJSONList :: [DeniedFirewall] -> Value # toEncodingList :: [DeniedFirewall] -> Encoding # omitField :: DeniedFirewall -> Bool #
Show DeniedFirewall Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods showsPrec :: Int -> DeniedFirewall -> ShowS # show :: DeniedFirewall -> String # showList :: [DeniedFirewall] -> ShowS #
Eq DeniedFirewall Source #
Instance details Defined in Google.Cloud.Compute.Firewall Methods (==) :: DeniedFirewall -> DeniedFirewall -> Bool # (/=) :: DeniedFirewall -> DeniedFirewall -> Bool #

defaultCreateFirewallOps :: String -> CreateFirewallOps Source #

Default firewall creation options

Creates minimal valid configuration with required name. Additional fields can be added using record update syntax:

defaultCreateFirewallOps "web-allow" 
  { description = Just "Allow web traffic"
  , allowed = Just [AllowedFirewall "tcp" (Just ["80","443"])]
  }