Class: Google::Apis::ComputeAlpha::SecurityPolicy

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb

Overview

Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SecurityPolicy

Returns a new instance of SecurityPolicy.



36104
36105
36106
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36104

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#adaptive_protection_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyAdaptiveProtectionConfig

Configuration options for Cloud Armor Adaptive Protection (CAAP). Corresponds to the JSON property adaptiveProtectionConfig

Returns:



35961
35962
35963
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 35961

def adaptive_protection_config
  @adaptive_protection_config
end

#advanced_options_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyAdvancedOptionsConfig

Corresponds to the JSON property advancedOptionsConfig

Returns:



35966
35967
35968
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 35966

def advanced_options_config
  @advanced_options_config
end

#associations ⇒ Array<Google::Apis::ComputeAlpha::SecurityPolicyAssociation>

A list of associations that belong to this policy. Corresponds to the JSON property associations

Returns:



35971
35972
35973
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 35971

def associations
  @associations
end

#cloud_armor_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyCloudArmorConfig

Configuration options for Cloud Armor. Corresponds to the JSON property cloudArmorConfig

Returns:



35976
35977
35978
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 35976

def cloud_armor_config
  @cloud_armor_config
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


35981
35982
35983
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 35981

def creation_timestamp
  @creation_timestamp
end

#ddos_protection_config ⇒ Google::Apis::ComputeAlpha::SecurityPolicyDdosProtectionConfig

Corresponds to the JSON property ddosProtectionConfig

Returns:



35986
35987
35988
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 35986

def ddos_protection_config
  @ddos_protection_config
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


35992
35993
35994
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 35992

def description
  @description
end

#display_name ⇒ String

User-provided name of the Organization security plicy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property displayName

Returns:

  • (String) 


36004
36005
36006
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36004

def display_name
  @display_name
end

#fingerprint ⇒ String

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


36016
36017
36018
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36016

def fingerprint
  @fingerprint
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


36022
36023
36024
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36022

def id
  @id
end

#kind ⇒ String

[Output only] Type of the resource. Always compute#securityPolicyfor security policies Corresponds to the JSON property kind

Returns:

  • (String) 


36028
36029
36030
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36028

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


36039
36040
36041
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36039

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<String,String>

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


36046
36047
36048
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36046

def labels
  @labels
end

#name ⇒ String

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])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property name

Returns:

  • (String) 


36056
36057
36058
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36056

def name
  @name
end

#parent ⇒ String

[Output Only] The parent of the security policy. Corresponds to the JSON property parent

Returns:

  • (String) 


36061
36062
36063
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36061

def parent
  @parent
end

#region ⇒ String

[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. Corresponds to the JSON property region

Returns:

  • (String) 


36067
36068
36069
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36067

def region
  @region
end

#rule_tuple_count ⇒ Fixnum

[Output Only] Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples. Corresponds to the JSON property ruleTupleCount

Returns:

  • (Fixnum) 


36073
36074
36075
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36073

def rule_tuple_count
  @rule_tuple_count
end

#rules ⇒ Array<Google::Apis::ComputeAlpha::SecurityPolicyRule>

A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. Corresponds to the JSON property rules

Returns:



36081
36082
36083
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36081

def rules
  @rules
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


36086
36087
36088
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36086

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


36091
36092
36093
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36091

def self_link_with_id
  @self_link_with_id
end

#type ⇒ String

The type indicates the intended use of the security policy. CLOUD_ARMOR - Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. CLOUD_ARMOR_EDGE - Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services ( including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. Corresponds to the JSON property type

Returns:

  • (String) 


36102
36103
36104
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36102

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



36109
36110
36111
36112
36113
36114
36115
36116
36117
36118
36119
36120
36121
36122
36123
36124
36125
36126
36127
36128
36129
36130
36131
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 36109

def update!(**args)
  @adaptive_protection_config = args[:adaptive_protection_config] if args.key?(:adaptive_protection_config)
  @advanced_options_config = args[:advanced_options_config] if args.key?(:advanced_options_config)
  @associations = args[:associations] if args.key?(:associations)
  @cloud_armor_config = args[:cloud_armor_config] if args.key?(:cloud_armor_config)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @ddos_protection_config = args[:ddos_protection_config] if args.key?(:ddos_protection_config)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @parent = args[:parent] if args.key?(:parent)
  @region = args[:region] if args.key?(:region)
  @rule_tuple_count = args[:rule_tuple_count] if args.key?(:rule_tuple_count)
  @rules = args[:rules] if args.key?(:rules)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @type = args[:type] if args.key?(:type)
end