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.



8829
8830
8831
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8829

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:



8765
8766
8767
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8765

def allow
  @allow
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:



8777
8778
8779
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8777

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) 


8782
8783
8784
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8782

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:



8787
8788
8789
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8787

def deny
  @deny
end

#description ⇒ String

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

Returns:

  • (String) 


8792
8793
8794
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8792

def description
  @description
end

#expire_time ⇒ String

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

Returns:

  • (String) 


8797
8798
8799
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8797

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:



8802
8803
8804
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8802

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) 


8810
8811
8812
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8810

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) 


8816
8817
8818
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8816

def state
  @state
end

#ttl ⇒ String

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

Returns:

  • (String) 


8821
8822
8823
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8821

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) 


8827
8828
8829
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8827

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 8834

def update!(**args)
  @allow = args[:allow] if args.key?(:allow)
  @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