GoogleCloudApigeeV1SecurityAction (Apigee API v1-rev20251125-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.apigee.v1.model.GoogleCloudApigeeV1SecurityAction

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudApigeeV1SecurityAction
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Apigee API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudApigeeV1SecurityAction()

Constructors
Constructor and Description
`GoogleCloudApigeeV1SecurityAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudApigeeV1SecurityAction`	`clone()`
`GoogleCloudApigeeV1SecurityActionAllow`	`getAllow()` Allow a request through if it matches this SecurityAction.
`List<String>`	`getApiProxies()` Optional.
`GoogleCloudApigeeV1SecurityActionConditionConfig`	`getConditionConfig()` Required.
`String`	`getCreateTime()` Output only.
`GoogleCloudApigeeV1SecurityActionDeny`	`getDeny()` Deny a request through if it matches this SecurityAction.
`String`	`getDescription()` Optional.
`String`	`getExpireTime()` The expiration for this SecurityAction.
`GoogleCloudApigeeV1SecurityActionFlag`	`getFlag()` Flag a request through if it matches this SecurityAction.
`String`	`getName()` Immutable.
`String`	`getState()` Required.
`String`	`getTtl()` Input only.
`String`	`getUpdateTime()` Output only.
`GoogleCloudApigeeV1SecurityAction`	`set(String fieldName, Object value)`
`GoogleCloudApigeeV1SecurityAction`	`setAllow(GoogleCloudApigeeV1SecurityActionAllow allow)` Allow a request through if it matches this SecurityAction.
`GoogleCloudApigeeV1SecurityAction`	`setApiProxies(List<String> apiProxies)` Optional.
`GoogleCloudApigeeV1SecurityAction`	`setConditionConfig(GoogleCloudApigeeV1SecurityActionConditionConfig conditionConfig)` Required.
`GoogleCloudApigeeV1SecurityAction`	`setCreateTime(String createTime)` Output only.
`GoogleCloudApigeeV1SecurityAction`	`setDeny(GoogleCloudApigeeV1SecurityActionDeny deny)` Deny a request through if it matches this SecurityAction.
`GoogleCloudApigeeV1SecurityAction`	`setDescription(String description)` Optional.
`GoogleCloudApigeeV1SecurityAction`	`setExpireTime(String expireTime)` The expiration for this SecurityAction.
`GoogleCloudApigeeV1SecurityAction`	`setFlag(GoogleCloudApigeeV1SecurityActionFlag flag)` Flag a request through if it matches this SecurityAction.
`GoogleCloudApigeeV1SecurityAction`	`setName(String name)` Immutable.
`GoogleCloudApigeeV1SecurityAction`	`setState(String state)` Required.
`GoogleCloudApigeeV1SecurityAction`	`setTtl(String ttl)` Input only.
`GoogleCloudApigeeV1SecurityAction`	`setUpdateTime(String updateTime)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudApigeeV1SecurityAction
```
public GoogleCloudApigeeV1SecurityAction()
```
- Method Detail
  - getAllow
```
public GoogleCloudApigeeV1SecurityActionAllow getAllow()
```
    Allow a request through if it matches this SecurityAction.
    
    Returns:
    
    value or null for none
  - setAllow
```
public GoogleCloudApigeeV1SecurityAction setAllow(GoogleCloudApigeeV1SecurityActionAllow allow)
```
    Allow a request through if it matches this SecurityAction.
    
    Parameters:
    
    allow - allow or null for none
  - getApiProxies
```
public List<String> getApiProxies()
```
    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.
    
    Returns:
    
    value or null for none
  - setApiProxies
```
public GoogleCloudApigeeV1SecurityAction setApiProxies(List<String> apiProxies)
```
    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.
    
    Parameters:
    
    apiProxies - apiProxies or null for none
  - getConditionConfig
```
public GoogleCloudApigeeV1SecurityActionConditionConfig getConditionConfig()
```
    Required. A valid SecurityAction must contain at least one condition.
    
    Returns:
    
    value or null for none
  - setConditionConfig
```
public GoogleCloudApigeeV1SecurityAction setConditionConfig(GoogleCloudApigeeV1SecurityActionConditionConfig conditionConfig)
```
    Required. A valid SecurityAction must contain at least one condition.
    
    Parameters:
    
    conditionConfig - conditionConfig or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The create time for this SecurityAction.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public GoogleCloudApigeeV1SecurityAction setCreateTime(String createTime)
```
    Output only. The create time for this SecurityAction.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDeny
```
public GoogleCloudApigeeV1SecurityActionDeny getDeny()
```
    Deny a request through if it matches this SecurityAction.
    
    Returns:
    
    value or null for none
  - setDeny
```
public GoogleCloudApigeeV1SecurityAction setDeny(GoogleCloudApigeeV1SecurityActionDeny deny)
```
    Deny a request through if it matches this SecurityAction.
    
    Parameters:
    
    deny - deny or null for none
  - getDescription
```
public String getDescription()
```
    Optional. An optional user provided description of the SecurityAction.
    
    Returns:
    
    value or null for none
  - setDescription
```
public GoogleCloudApigeeV1SecurityAction setDescription(String description)
```
    Optional. An optional user provided description of the SecurityAction.
    
    Parameters:
    
    description - description or null for none
  - getExpireTime
```
public String getExpireTime()
```
    The expiration for this SecurityAction.
    
    Returns:
    
    value or null for none
  - setExpireTime
```
public GoogleCloudApigeeV1SecurityAction setExpireTime(String expireTime)
```
    The expiration for this SecurityAction.
    
    Parameters:
    
    expireTime - expireTime or null for none
  - getFlag
```
public GoogleCloudApigeeV1SecurityActionFlag getFlag()
```
    Flag a request through if it matches this SecurityAction.
    
    Returns:
    
    value or null for none
  - setFlag
```
public GoogleCloudApigeeV1SecurityAction setFlag(GoogleCloudApigeeV1SecurityActionFlag flag)
```
    Flag a request through if it matches this SecurityAction.
    
    Parameters:
    
    flag - flag or null for none
  - getName
```
public String getName()
```
    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}
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudApigeeV1SecurityAction setName(String name)
```
    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}
    
    Parameters:
    
    name - name or null for none
  - getState
```
public String getState()
```
    Required. Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
    
    Returns:
    
    value or null for none
  - setState
```
public GoogleCloudApigeeV1SecurityAction setState(String state)
```
    Required. Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
    
    Parameters:
    
    state - state or null for none
  - getTtl
```
public String getTtl()
```
    Input only. The TTL for this SecurityAction.
    
    Returns:
    
    value or null for none
  - setTtl
```
public GoogleCloudApigeeV1SecurityAction setTtl(String ttl)
```
    Input only. The TTL for this SecurityAction.
    
    Parameters:
    
    ttl - ttl or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The update time for this SecurityAction. This reflects when this SecurityAction changed states.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public GoogleCloudApigeeV1SecurityAction setUpdateTime(String updateTime)
```
    Output only. The update time for this SecurityAction. This reflects when this SecurityAction changed states.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public GoogleCloudApigeeV1SecurityAction set(String fieldName,
                                             Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudApigeeV1SecurityAction clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudApigeeV1SecurityAction

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudApigeeV1SecurityAction

Method Detail

getAllow

setAllow

getApiProxies

setApiProxies

getConditionConfig

setConditionConfig

getCreateTime

setCreateTime

getDeny

setDeny

getDescription

setDescription

getExpireTime

setExpireTime

getFlag

setFlag

getName

setName

getState

setState

getTtl

setTtl

getUpdateTime

setUpdateTime

set

clone