Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityAction

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

Overview

A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1SecurityAction

Returns a new instance of GoogleCloudApigeeV1SecurityAction.



10863
10864
10865
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10863

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

Instance Attribute Details

#allow ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionAllow

Message that should be set in case of an Allow Action. This does not have any fields. Corresponds to the JSON property allow

Returns:



10789
10790
10791
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10789

def allow
  @allow
end

#api_proxies ⇒ Array<String>

Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later. Corresponds to the JSON property apiProxies

Returns:

  • (Array<String>) 


10799
10800
10801
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10799

def api_proxies
  @api_proxies
end

#condition_config ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionConditionConfig

The following are a list of conditions. A valid SecurityAction must contain at least one condition. Within a condition, each element is ORed. Across conditions elements are ANDed. For example if a SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and bot_reasons: ["Flooder", " Robot Abuser"] then this is interpreted as: enforce the action if the incoming request has ((ip_address_ranges = "ip1" OR ip_address_ranges = "ip2") AND ( bot_reasons="Flooder" OR bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges and bot_reasons cannot be ANDed. Corresponds to the JSON property conditionConfig

Returns:



10811
10812
10813
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10811

def condition_config
  @condition_config
end

#create_time ⇒ String

Output only. The create time for this SecurityAction. Corresponds to the JSON property createTime

Returns:

  • (String) 


10816
10817
10818
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10816

def create_time
  @create_time
end

#deny ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionDeny

Message that should be set in case of a Deny Action. Corresponds to the JSON property deny

Returns:



10821
10822
10823
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10821

def deny
  @deny
end

#description ⇒ String

Optional. An optional user provided description of the SecurityAction. Corresponds to the JSON property description

Returns:

  • (String) 


10826
10827
10828
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10826

def description
  @description
end

#expire_time ⇒ String

The expiration for this SecurityAction. Corresponds to the JSON property expireTime

Returns:

  • (String) 


10831
10832
10833
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10831

def expire_time
  @expire_time
end

#flag ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1SecurityActionFlag

The message that should be set in the case of a Flag action. Corresponds to the JSON property flag

Returns:



10836
10837
10838
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10836

def flag
  @flag
end

#name ⇒ String

Immutable. This field is ignored during creation as per AIP-133. Please set the security_action_id field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/org/environments/env/ securityActions/security_action Corresponds to the JSON property name

Returns:

  • (String) 


10844
10845
10846
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10844

def name
  @name
end

#state ⇒ String

Required. Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced. Corresponds to the JSON property state

Returns:

  • (String) 


10850
10851
10852
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10850

def state
  @state
end

#ttl ⇒ String

Input only. The TTL for this SecurityAction. Corresponds to the JSON property ttl

Returns:

  • (String) 


10855
10856
10857
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10855

def ttl
  @ttl
end

#update_time ⇒ String

Output only. The update time for this SecurityAction. This reflects when this SecurityAction changed states. Corresponds to the JSON property updateTime

Returns:

  • (String) 


10861
10862
10863
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10861

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 10868

def update!(**args)
  @allow = args[:allow] if args.key?(:allow)
  @api_proxies = args[:api_proxies] if args.key?(:api_proxies)
  @condition_config = args[:condition_config] if args.key?(:condition_config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deny = args[:deny] if args.key?(:deny)
  @description = args[:description] if args.key?(:description)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @flag = args[:flag] if args.key?(:flag)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @ttl = args[:ttl] if args.key?(:ttl)
  @update_time = args[:update_time] if args.key?(:update_time)
end