1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Apigee
  7. \
  8. Resource
  9. \
  10. OrganizationsEnvironmentsSecurityActions

OrganizationsEnvironmentsSecurityActions

class OrganizationsEnvironmentsSecurityActions extends Resource (View source)

The "securityActions" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $securityActions = $apigeeService->organizations_environments_securityActions;

Methods

GoogleCloudApigeeV1SecurityAction
create(string $parent, GoogleCloudApigeeV1SecurityAction $postBody, array $optParams = [])

CreateSecurityAction creates a SecurityAction. (securityActions.create)

GoogleCloudApigeeV1SecurityAction
disable(string $name, GoogleCloudApigeeV1DisableSecurityActionRequest $postBody, array $optParams = [])

Disable a SecurityAction. The state of the SecurityAction after disabling is DISABLED. DisableSecurityAction can be called on SecurityActions in the state ENABLED; SecurityActions in a different state (including DISABLED) return an error. (securityActions.disable)

GoogleCloudApigeeV1SecurityAction
enable(string $name, GoogleCloudApigeeV1EnableSecurityActionRequest $postBody, array $optParams = [])

Enable a SecurityAction. The state of the SecurityAction after enabling is ENABLED. EnableSecurityAction can be called on SecurityActions in the state DISABLED; SecurityActions in a different state (including `ENABLED) return an error. (securityActions.enable)

GoogleCloudApigeeV1SecurityAction
get(string $name, array $optParams = [])

Get a SecurityAction by name. (securityActions.get)

GoogleCloudApigeeV1ListSecurityActionsResponse
listOrganizationsEnvironmentsSecurityActions(string $parent, array $optParams = [])

Returns a list of SecurityActions. This returns both enabled and disabled actions. (securityActions.listOrganizationsEnvironmentsSecurityActions)

Details

at line 50
GoogleCloudApigeeV1SecurityAction create(string $parent, GoogleCloudApigeeV1SecurityAction $postBody, array $optParams = [])

CreateSecurityAction creates a SecurityAction. (securityActions.create)

Parameters

string $parent

Required. The organization and environment that this SecurityAction applies to. Format: organizations/{org}/environments/{env}
GoogleCloudApigeeV1SecurityAction $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecurityAction

Exceptions

Exception

at line 70
GoogleCloudApigeeV1SecurityAction disable(string $name, GoogleCloudApigeeV1DisableSecurityActionRequest $postBody, array $optParams = [])

Disable a SecurityAction. The state of the SecurityAction after disabling is DISABLED. DisableSecurityAction can be called on SecurityActions in the state ENABLED; SecurityActions in a different state (including DISABLED) return an error. (securityActions.disable)

Parameters

string $name

Required. The name of the SecurityAction to disable. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
GoogleCloudApigeeV1DisableSecurityActionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecurityAction

Exceptions

Exception

at line 90
GoogleCloudApigeeV1SecurityAction enable(string $name, GoogleCloudApigeeV1EnableSecurityActionRequest $postBody, array $optParams = [])

Enable a SecurityAction. The state of the SecurityAction after enabling is ENABLED. EnableSecurityAction can be called on SecurityActions in the state DISABLED; SecurityActions in a different state (including `ENABLED) return an error. (securityActions.enable)

Parameters

string $name

Required. The name of the SecurityAction to enable. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
GoogleCloudApigeeV1EnableSecurityActionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecurityAction

Exceptions

Exception

at line 106
GoogleCloudApigeeV1SecurityAction get(string $name, array $optParams = [])

Get a SecurityAction by name. (securityActions.get)

Parameters

string $name

Required. The fully qualified name of the SecurityAction to retrieve. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecurityAction

Exceptions

Exception

at line 134
GoogleCloudApigeeV1ListSecurityActionsResponse listOrganizationsEnvironmentsSecurityActions(string $parent, array $optParams = [])

Returns a list of SecurityActions. This returns both enabled and disabled actions. (securityActions.listOrganizationsEnvironmentsSecurityActions)

Parameters

string $parent

Required. The parent, which owns this collection of SecurityActions. Format: organizations/{org}/environments/{env}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListSecurityActionsResponse

Exceptions

Exception