Skip to content

compute.v1beta1.computeFirewallPolicyRule

"ComputeFirewallPolicyRule is the Schema for the compute API"

Index

Fields

fn new

new(name)

new returns an instance of ComputeFirewallPolicyRule

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

fn spec.withAction

withAction(action)

"The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\"."

fn spec.withDescription

withDescription(description)

"An optional description for this resource."

fn spec.withDirection

withDirection(direction)

"The direction in which this rule applies. Possible values: INGRESS, EGRESS"

fn spec.withDisabled

withDisabled(disabled)

"Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled."

fn spec.withEnableLogging

withEnableLogging(enableLogging)

"Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules."

fn spec.withPriority

withPriority(priority)

"Immutable. An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority."

fn spec.withTargetResources

withTargetResources(targetResources)

fn spec.withTargetResourcesMixin

withTargetResourcesMixin(targetResources)

Note: This function appends passed data to existing values

fn spec.withTargetServiceAccounts

withTargetServiceAccounts(targetServiceAccounts)

fn spec.withTargetServiceAccountsMixin

withTargetServiceAccountsMixin(targetServiceAccounts)

Note: This function appends passed data to existing values

obj spec.firewallPolicyRef

"Immutable."

fn spec.firewallPolicyRef.withExternal

withExternal(external)

"A reference to an externally managed ComputeFirewallPolicy resource. Should be in the format locations/global/firewallPolicies/<firewallPolicy>."

fn spec.firewallPolicyRef.withName

withName(name)

"The name field of a ComputeFirewall olicy resource."

fn spec.firewallPolicyRef.withNamespace

withNamespace(namespace)

"The namespace field of a ComputeFirewallPolicy resource."

obj spec.match

"A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced."

fn spec.match.withDestAddressGroups

withDestAddressGroups(destAddressGroups)

"Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules."

fn spec.match.withDestAddressGroupsMixin

withDestAddressGroupsMixin(destAddressGroups)

"Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. Destination address groups is only supported in Egress rules."

Note: This function appends passed data to existing values

fn spec.match.withDestFqdns

withDestFqdns(destFqdns)

"Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress."

fn spec.match.withDestFqdnsMixin

withDestFqdnsMixin(destFqdns)

"Domain names that will be used to match against the resolved domain name of destination of traffic. Can only be specified if DIRECTION is egress."

Note: This function appends passed data to existing values

fn spec.match.withDestIPRanges

withDestIPRanges(destIPRanges)

"CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256."

fn spec.match.withDestIPRangesMixin

withDestIPRangesMixin(destIPRanges)

"CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256."

Note: This function appends passed data to existing values

fn spec.match.withDestRegionCodes

withDestRegionCodes(destRegionCodes)

"The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress."

fn spec.match.withDestRegionCodesMixin

withDestRegionCodesMixin(destRegionCodes)

"The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is egress."

Note: This function appends passed data to existing values

fn spec.match.withDestThreatIntelligences

withDestThreatIntelligences(destThreatIntelligences)

"Name of the Google Cloud Threat Intelligence list."

fn spec.match.withDestThreatIntelligencesMixin

withDestThreatIntelligencesMixin(destThreatIntelligences)

"Name of the Google Cloud Threat Intelligence list."

Note: This function appends passed data to existing values

fn spec.match.withLayer4Configs

withLayer4Configs(layer4Configs)

"Pairs of IP protocols and ports that the rule should match."

fn spec.match.withLayer4ConfigsMixin

withLayer4ConfigsMixin(layer4Configs)

"Pairs of IP protocols and ports that the rule should match."

Note: This function appends passed data to existing values

fn spec.match.withSrcAddressGroups

withSrcAddressGroups(srcAddressGroups)

"Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules."

fn spec.match.withSrcAddressGroupsMixin

withSrcAddressGroupsMixin(srcAddressGroups)

"Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. Source address groups is only supported in Ingress rules."

Note: This function appends passed data to existing values

fn spec.match.withSrcFqdns

withSrcFqdns(srcFqdns)

"Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress."

fn spec.match.withSrcFqdnsMixin

withSrcFqdnsMixin(srcFqdns)

"Domain names that will be used to match against the resolved domain name of source of traffic. Can only be specified if DIRECTION is ingress."

Note: This function appends passed data to existing values

fn spec.match.withSrcIPRanges

withSrcIPRanges(srcIPRanges)

"CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256."

fn spec.match.withSrcIPRangesMixin

withSrcIPRangesMixin(srcIPRanges)

"CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256."

Note: This function appends passed data to existing values

fn spec.match.withSrcRegionCodes

withSrcRegionCodes(srcRegionCodes)

"The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress."

fn spec.match.withSrcRegionCodesMixin

withSrcRegionCodesMixin(srcRegionCodes)

"The Unicode country codes whose IP addresses will be used to match against the source of traffic. Can only be specified if DIRECTION is ingress."

Note: This function appends passed data to existing values

fn spec.match.withSrcThreatIntelligences

withSrcThreatIntelligences(srcThreatIntelligences)

"Name of the Google Cloud Threat Intelligence list."

fn spec.match.withSrcThreatIntelligencesMixin

withSrcThreatIntelligencesMixin(srcThreatIntelligences)

"Name of the Google Cloud Threat Intelligence list."

Note: This function appends passed data to existing values

obj spec.match.layer4Configs

"Pairs of IP protocols and ports that the rule should match."

fn spec.match.layer4Configs.withIpProtocol

withIpProtocol(ipProtocol)

"The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number."

fn spec.match.layer4Configs.withPorts

withPorts(ports)

"An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ``."

fn spec.match.layer4Configs.withPortsMixin

withPortsMixin(ports)

"An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ``."

Note: This function appends passed data to existing values

obj spec.targetResources

fn spec.targetResources.withExternal

withExternal(external)

"A reference to an externally managed Compute Network resource. Should be in the format projects/<projectID>/global/networks/<network>."

fn spec.targetResources.withName

withName(name)

"The name field of a ComputeNetwork resource."

fn spec.targetResources.withNamespace

withNamespace(namespace)

"The namespace field of a ComputeNetwork resource."

obj spec.targetServiceAccounts

fn spec.targetServiceAccounts.withExternal

withExternal(external)

"The email field of an IAMServiceAccount resource."

fn spec.targetServiceAccounts.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.targetServiceAccounts.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"