Documentation

Google_Service_Appengine_Resource_AppsFirewallIngressRules extends Google_Service_Resource
in package

The "ingressRules" collection of methods.

Typical usage is: $appengineService = new Google_Service_Appengine(...); $ingressRules = $appengineService->ingressRules;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
batchUpdate()  : Google_Service_Appengine_BatchUpdateIngressRulesResponse
Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Appengine_FirewallRule
Creates a firewall rule for the application. (ingressRules.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Appengine_AppengineEmpty
Deletes the specified firewall rule. (ingressRules.delete)
get()  : Google_Service_Appengine_FirewallRule
Gets the specified firewall rule. (ingressRules.get)
listAppsFirewallIngressRules()  : Google_Service_Appengine_ListIngressRulesResponse
Lists the firewall rules of an application.
patch()  : Google_Service_Appengine_FirewallRule
Updates the specified firewall rule. (ingressRules.patch)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

batchUpdate()

Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.

public batchUpdate(string $appsId, Google_Service_Appengine_BatchUpdateIngressRulesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_BatchUpdateIngressRulesResponse

(ingressRules.batchUpdate)

Parameters
$appsId : string

Part of name. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.

$postBody : Google_Service_Appengine_BatchUpdateIngressRulesRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Appengine_BatchUpdateIngressRulesResponse

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates a firewall rule for the application. (ingressRules.create)

public create(string $appsId, Google_Service_Appengine_FirewallRule $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_FirewallRule
Parameters
$appsId : string

Part of parent. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.

$postBody : Google_Service_Appengine_FirewallRule
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Appengine_FirewallRule

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes the specified firewall rule. (ingressRules.delete)

public delete(string $appsId, string $ingressRulesId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_AppengineEmpty
Parameters
$appsId : string

Part of name. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.

$ingressRulesId : string

Part of name. See documentation of appsId.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Appengine_AppengineEmpty

get()

Gets the specified firewall rule. (ingressRules.get)

public get(string $appsId, string $ingressRulesId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_FirewallRule
Parameters
$appsId : string

Part of name. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.

$ingressRulesId : string

Part of name. See documentation of appsId.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Appengine_FirewallRule

listAppsFirewallIngressRules()

Lists the firewall rules of an application.

public listAppsFirewallIngressRules(string $appsId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_ListIngressRulesResponse

(ingressRules.listAppsFirewallIngressRules)

Parameters
$appsId : string

Part of parent. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Maximum results to return per page.

opt_param

string matchingAddress A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.

opt_param

string pageToken Continuation token for fetching the next page of results.

Return values
Google_Service_Appengine_ListIngressRulesResponse

patch()

Updates the specified firewall rule. (ingressRules.patch)

public patch(string $appsId, string $ingressRulesId, Google_Service_Appengine_FirewallRule $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Appengine_FirewallRule
Parameters
$appsId : string

Part of name. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.

$ingressRulesId : string

Part of name. See documentation of appsId.

$postBody : Google_Service_Appengine_FirewallRule
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Standard field mask for the set of fields to be updated.

Return values
Google_Service_Appengine_FirewallRule

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results