close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

Args:
parent: string, Required. The name of the project this policy will apply to, in the format `projects/{project}`. (required)
body: object, The request body.
The object takes the form of:

{ # A FirewallPolicy represents a single matching pattern and resulting actions to take.
"actions": [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
{ # An individual action. Each action represents what to do if a policy matches.
"allow": { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
},
"block": { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action will deny access to a given page. The user will get an HTTP error code.
},
"includeRecaptchaScript": { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend.
},
"redirect": { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token. # This action will redirect the request to a ReCaptcha interstitial to attach a token.
},
"setHeader": { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action will set a custom header but allow the request to continue to the customer backend.
"key": "A String", # Optional. The header key to set in the request to the backend server.
"value": "A String", # Optional. The header value to set in the request to the backend server.
},
"substitute": { # A substitute action transparently serves a different page than the one requested. # This action will transparently serve a different page to an offending user.
"path": "A String", # Optional. The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".
},
},
],
"condition": "A String", # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
"description": "A String", # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
"name": "A String", # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
"path": "A String", # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A FirewallPolicy represents a single matching pattern and resulting actions to take.
"actions": [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
{ # An individual action. Each action represents what to do if a policy matches.
"allow": { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
},
"block": { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action will deny access to a given page. The user will get an HTTP error code.
},
"includeRecaptchaScript": { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend.
},
"redirect": { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token. # This action will redirect the request to a ReCaptcha interstitial to attach a token.
},
"setHeader": { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action will set a custom header but allow the request to continue to the customer backend.
"key": "A String", # Optional. The header key to set in the request to the backend server.
"value": "A String", # Optional. The header value to set in the request to the backend server.
},
"substitute": { # A substitute action transparently serves a different page than the one requested. # This action will transparently serve a different page to an offending user.
"path": "A String", # Optional. The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".
},
},
],
"condition": "A String", # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
"description": "A String", # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
"name": "A String", # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
"path": "A String", # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
}

delete(name, x__xgafv=None)

Deletes the specified firewall policy.

Args:
  name: string, Required. The name of the policy to be deleted, in the format `projects/{project}/firewallpolicies/{firewallpolicy}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Returns the specified firewall policy.

Args:
name: string, Required. The name of the requested policy, in the format `projects/{project}/firewallpolicies/{firewallpolicy}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A FirewallPolicy represents a single matching pattern and resulting actions to take.
"actions": [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
{ # An individual action. Each action represents what to do if a policy matches.
"allow": { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
},
"block": { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action will deny access to a given page. The user will get an HTTP error code.
},
"includeRecaptchaScript": { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend.
},
"redirect": { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token. # This action will redirect the request to a ReCaptcha interstitial to attach a token.
},
"setHeader": { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action will set a custom header but allow the request to continue to the customer backend.
"key": "A String", # Optional. The header key to set in the request to the backend server.
"value": "A String", # Optional. The header value to set in the request to the backend server.
},
"substitute": { # A substitute action transparently serves a different page than the one requested. # This action will transparently serve a different page to an offending user.
"path": "A String", # Optional. The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".
},
},
],
"condition": "A String", # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
"description": "A String", # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
"name": "A String", # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
"path": "A String", # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Returns the list of all firewall policies that belong to a project.

Args:
parent: string, Required. The name of the project to list the policies for, in the format `projects/{project}`. (required)
pageSize: integer, Optional. The maximum number of policies to return. Default is 10. Max limit is 1000.
pageToken: string, Optional. The next_page_token value returned from a previous. ListFirewallPoliciesRequest, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response to request to list firewall policies belonging to a project.
"firewallPolicies": [ # Policy details.
{ # A FirewallPolicy represents a single matching pattern and resulting actions to take.
"actions": [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
{ # An individual action. Each action represents what to do if a policy matches.
"allow": { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
},
"block": { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action will deny access to a given page. The user will get an HTTP error code.
},
"includeRecaptchaScript": { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend.
},
"redirect": { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token. # This action will redirect the request to a ReCaptcha interstitial to attach a token.
},
"setHeader": { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action will set a custom header but allow the request to continue to the customer backend.
"key": "A String", # Optional. The header key to set in the request to the backend server.
"value": "A String", # Optional. The header value to set in the request to the backend server.
},
"substitute": { # A substitute action transparently serves a different page than the one requested. # This action will transparently serve a different page to an offending user.
"path": "A String", # Optional. The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".
},
},
],
"condition": "A String", # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
"description": "A String", # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
"name": "A String", # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
"path": "A String", # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results. It is set to empty if no policies remain in results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the specified firewall policy.

Args:
name: string, Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`. (required)
body: object, The request body.
The object takes the form of:

{ # A FirewallPolicy represents a single matching pattern and resulting actions to take.
"actions": [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
{ # An individual action. Each action represents what to do if a policy matches.
"allow": { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
},
"block": { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action will deny access to a given page. The user will get an HTTP error code.
},
"includeRecaptchaScript": { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend.
},
"redirect": { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token. # This action will redirect the request to a ReCaptcha interstitial to attach a token.
},
"setHeader": { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action will set a custom header but allow the request to continue to the customer backend.
"key": "A String", # Optional. The header key to set in the request to the backend server.
"value": "A String", # Optional. The header value to set in the request to the backend server.
},
"substitute": { # A substitute action transparently serves a different page than the one requested. # This action will transparently serve a different page to an offending user.
"path": "A String", # Optional. The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".
},
},
],
"condition": "A String", # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
"description": "A String", # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
"name": "A String", # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
"path": "A String", # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
}

updateMask: string, Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A FirewallPolicy represents a single matching pattern and resulting actions to take.
"actions": [ # Optional. The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`. Zero or more non-terminal actions such as `SetHeader` might be specified. A single policy can contain up to 16 actions.
{ # An individual action. Each action represents what to do if a policy matches.
"allow": { # An allow action continues processing a request unimpeded. # The user request did not match any policy and should be allowed access to the requested resource.
},
"block": { # A block action serves an HTTP error code a prevents the request from hitting the backend. # This action will deny access to a given page. The user will get an HTTP error code.
},
"includeRecaptchaScript": { # An include reCAPTCHA script action involves injecting reCAPTCHA JavaScript code into the HTML returned by the site backend. This reCAPTCHA script is tasked with collecting user signals on the requested web page, issuing tokens as a cookie within the site domain, and enabling their utilization in subsequent page requests. # This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend.
},
"redirect": { # A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token. # This action will redirect the request to a ReCaptcha interstitial to attach a token.
},
"setHeader": { # A set header action sets a header and forwards the request to the backend. This can be used to trigger custom protection implemented on the backend. # This action will set a custom header but allow the request to continue to the customer backend.
"key": "A String", # Optional. The header key to set in the request to the backend server.
"value": "A String", # Optional. The header value to set in the request to the backend server.
},
"substitute": { # A substitute action transparently serves a different page than the one requested. # This action will transparently serve a different page to an offending user.
"path": "A String", # Optional. The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".
},
},
],
"condition": "A String", # Optional. A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters.
"description": "A String", # Optional. A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
"name": "A String", # Identifier. The resource name for the FirewallPolicy in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
"path": "A String", # Optional. The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters.
}

reorder(parent, body=None, x__xgafv=None)

Reorders all firewall policies.

Args:
  parent: string, Required. The name of the project to list the policies for, in the format `projects/{project}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # The reorder firewall policies request message.
  "names": [ # Required. A list containing all policy names, in the new order. Each name is in the format `projects/{project}/firewallpolicies/{firewallpolicy}`.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The reorder firewall policies response message.
}

reCAPTCHA Enterprise API . projects . firewallpolicies

Instance Methods

Method Details