Class v1.FirewallClient (1.0.6)

Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests.

Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user. v1

Package

@google-cloud/appengine-admin!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of FirewallClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value

Type	Description
string

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

firewallStub

firewallStub?: Promise<{
        [name: string]: Function;
    }>;

Property Value

Type	Description
Promise<{ [name: string]: Function; }>

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

Property Value

Type	Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

Property Value

Type	Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value

Type	Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;

Property Value

Type	Description
(code: string, message: string, warnType?: string) => void

Methods

batchUpdateIngressRules(request, options)

batchUpdateIngressRules(request?: protos.google.appengine.v1.IBatchUpdateIngressRulesRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IBatchUpdateIngressRulesResponse,
        protos.google.appengine.v1.IBatchUpdateIngressRulesRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.appengine.v1.IBatchUpdateIngressRulesRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.appengine.v1.IBatchUpdateIngressRulesResponse, protos.google.appengine.v1.IBatchUpdateIngressRulesRequest \| undefined, {} \| undefined ]>

batchUpdateIngressRules(request, options, callback)

batchUpdateIngressRules(request: protos.google.appengine.v1.IBatchUpdateIngressRulesRequest, options: CallOptions, callback: Callback<protos.google.appengine.v1.IBatchUpdateIngressRulesResponse, protos.google.appengine.v1.IBatchUpdateIngressRulesRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IBatchUpdateIngressRulesRequest`
options	`CallOptions`
callback	`Callback<protos.google.appengine.v1.IBatchUpdateIngressRulesResponse, protos.google.appengine.v1.IBatchUpdateIngressRulesRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

batchUpdateIngressRules(request, callback)

batchUpdateIngressRules(request: protos.google.appengine.v1.IBatchUpdateIngressRulesRequest, callback: Callback<protos.google.appengine.v1.IBatchUpdateIngressRulesResponse, protos.google.appengine.v1.IBatchUpdateIngressRulesRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IBatchUpdateIngressRulesRequest`
callback	`Callback<protos.google.appengine.v1.IBatchUpdateIngressRulesResponse, protos.google.appengine.v1.IBatchUpdateIngressRulesRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

createIngressRule(request, options)

createIngressRule(request?: protos.google.appengine.v1.ICreateIngressRuleRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IFirewallRule,
        protos.google.appengine.v1.ICreateIngressRuleRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.appengine.v1.ICreateIngressRuleRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.ICreateIngressRuleRequest \| undefined, {} \| undefined ]>

createIngressRule(request, options, callback)

createIngressRule(request: protos.google.appengine.v1.ICreateIngressRuleRequest, options: CallOptions, callback: Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.ICreateIngressRuleRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.ICreateIngressRuleRequest`
options	`CallOptions`
callback	`Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.ICreateIngressRuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createIngressRule(request, callback)

createIngressRule(request: protos.google.appengine.v1.ICreateIngressRuleRequest, callback: Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.ICreateIngressRuleRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.ICreateIngressRuleRequest`
callback	`Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.ICreateIngressRuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteIngressRule(request, options)

deleteIngressRule(request?: protos.google.appengine.v1.IDeleteIngressRuleRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.appengine.v1.IDeleteIngressRuleRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.appengine.v1.IDeleteIngressRuleRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.appengine.v1.IDeleteIngressRuleRequest \| undefined, {} \| undefined ]>

deleteIngressRule(request, options, callback)

deleteIngressRule(request: protos.google.appengine.v1.IDeleteIngressRuleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IDeleteIngressRuleRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IDeleteIngressRuleRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IDeleteIngressRuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteIngressRule(request, callback)

deleteIngressRule(request: protos.google.appengine.v1.IDeleteIngressRuleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IDeleteIngressRuleRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IDeleteIngressRuleRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.appengine.v1.IDeleteIngressRuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getIngressRule(request, options)

getIngressRule(request?: protos.google.appengine.v1.IGetIngressRuleRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IFirewallRule,
        protos.google.appengine.v1.IGetIngressRuleRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.appengine.v1.IGetIngressRuleRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.IGetIngressRuleRequest \| undefined, {} \| undefined ]>

getIngressRule(request, options, callback)

getIngressRule(request: protos.google.appengine.v1.IGetIngressRuleRequest, options: CallOptions, callback: Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.IGetIngressRuleRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IGetIngressRuleRequest`
options	`CallOptions`
callback	`Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.IGetIngressRuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getIngressRule(request, callback)

getIngressRule(request: protos.google.appengine.v1.IGetIngressRuleRequest, callback: Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.IGetIngressRuleRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IGetIngressRuleRequest`
callback	`Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.IGetIngressRuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

instancePath(app, service, version, instance)

instancePath(app: string, service: string, version: string, instance: string): string;

Return a fully-qualified instance resource name string.

Parameters

Name	Description
app	`string`
service	`string`
version	`string`
instance	`string`

Returns

Type	Description
string	{string} Resource name string.

listIngressRules(request, options)

listIngressRules(request?: protos.google.appengine.v1.IListIngressRulesRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IFirewallRule[],
        protos.google.appengine.v1.IListIngressRulesRequest | null,
        protos.google.appengine.v1.IListIngressRulesResponse
    ]>;

Parameters

Name	Description
request	`protos.google.appengine.v1.IListIngressRulesRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.appengine.v1.IFirewallRule[], protos.google.appengine.v1.IListIngressRulesRequest \| null, protos.google.appengine.v1.IListIngressRulesResponse ]>

listIngressRules(request, options, callback)

listIngressRules(request: protos.google.appengine.v1.IListIngressRulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.appengine.v1.IListIngressRulesRequest, protos.google.appengine.v1.IListIngressRulesResponse | null | undefined, protos.google.appengine.v1.IFirewallRule>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IListIngressRulesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.appengine.v1.IListIngressRulesRequest, protos.google.appengine.v1.IListIngressRulesResponse \| null \| undefined, protos.google.appengine.v1.IFirewallRule>`

Returns

Type	Description
void

listIngressRules(request, callback)

listIngressRules(request: protos.google.appengine.v1.IListIngressRulesRequest, callback: PaginationCallback<protos.google.appengine.v1.IListIngressRulesRequest, protos.google.appengine.v1.IListIngressRulesResponse | null | undefined, protos.google.appengine.v1.IFirewallRule>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IListIngressRulesRequest`
callback	`PaginationCallback<protos.google.appengine.v1.IListIngressRulesRequest, protos.google.appengine.v1.IListIngressRulesResponse \| null \| undefined, protos.google.appengine.v1.IFirewallRule>`

Returns

Type	Description
void

listIngressRulesAsync(request, options)

listIngressRulesAsync(request?: protos.google.appengine.v1.IListIngressRulesRequest, options?: CallOptions): AsyncIterable<protos.google.appengine.v1.IFirewallRule>;

Equivalent to listIngressRules, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.appengine.v1.IListIngressRulesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.appengine.v1.IFirewallRule>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [FirewallRule]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listIngressRulesStream(request, options)

listIngressRulesStream(request?: protos.google.appengine.v1.IListIngressRulesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.appengine.v1.IListIngressRulesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [FirewallRule] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listIngressRulesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchAppFromInstanceName(instanceName)

matchAppFromInstanceName(instanceName: string): string | number;

Parse the app from Instance resource.

Parameter

Name	Description
instanceName	`string` A fully-qualified path representing Instance resource.

Returns

Type	Description
string \| number	{string} A string representing the app.

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

Parse the instance from Instance resource.

Parameter

Name	Description
instanceName	`string` A fully-qualified path representing Instance resource.

Returns

Type	Description
string \| number	{string} A string representing the instance.

matchServiceFromInstanceName(instanceName)

matchServiceFromInstanceName(instanceName: string): string | number;

Parse the service from Instance resource.

Parameter

Name	Description
instanceName	`string` A fully-qualified path representing Instance resource.

Returns

Type	Description
string \| number	{string} A string representing the service.

matchVersionFromInstanceName(instanceName)

matchVersionFromInstanceName(instanceName: string): string | number;

Parse the version from Instance resource.

Parameter

Name	Description
instanceName	`string` A fully-qualified path representing Instance resource.

Returns

Type	Description
string \| number	{string} A string representing the version.

updateIngressRule(request, options)

updateIngressRule(request?: protos.google.appengine.v1.IUpdateIngressRuleRequest, options?: CallOptions): Promise<[
        protos.google.appengine.v1.IFirewallRule,
        protos.google.appengine.v1.IUpdateIngressRuleRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.appengine.v1.IUpdateIngressRuleRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.IUpdateIngressRuleRequest \| undefined, {} \| undefined ]>

updateIngressRule(request, options, callback)

updateIngressRule(request: protos.google.appengine.v1.IUpdateIngressRuleRequest, options: CallOptions, callback: Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.IUpdateIngressRuleRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IUpdateIngressRuleRequest`
options	`CallOptions`
callback	`Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.IUpdateIngressRuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateIngressRule(request, callback)

updateIngressRule(request: protos.google.appengine.v1.IUpdateIngressRuleRequest, callback: Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.IUpdateIngressRuleRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.appengine.v1.IUpdateIngressRuleRequest`
callback	`Callback<protos.google.appengine.v1.IFirewallRule, protos.google.appengine.v1.IUpdateIngressRuleRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void