Compute Engine API . managedRulesets

Instance Methods

close()

Close httplib2 connections.

get(project, managedRuleset, x__xgafv=None)

Gets the details for the specified managed ruleset name.

list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of all the managed rulesets available.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(project, managedRuleset, x__xgafv=None)
Gets the details for the specified managed ruleset name.

Args:
  project: string, Project ID for this request. (required)
  managedRuleset: string, Name of the managed ruleset to return. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a ManagedRuleset resource.
    #
    # Managed internally by Cloud Armor CLH for Managed Rules features.
    # Customers can only view these resources to modify their Security Policies.
    # For more information, see
    # https://cloud.google.com/armor/docs/.
  "changeLog": "A String", # Output only. [Output Only] The change log for this managed ruleset.
  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339 text format.
  "description": "A String", # [Output Only] An optional description of this resource.
  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
      # defined by the server.
  "name": "A String", # Name of the resource. Generated internally when the resource is created.
      # The name must be 1-63 characters long, and comply withRFC1035.
      # Specifically, the name must be 1-63 characters long and match the regular
      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      # character must be a lowercase letter, and all following characters must
      # be a dash, lowercase letter, or digit, except the last character, which
      # cannot be a dash.
  "ruleIds": [ # Output only. [Output Only] The list of managed rule IDs that are included in
      # this managed ruleset.
    "A String",
  ],
  "rulesetId": "A String", # Output only. [Output Only] The managed ruleset identifier that can be configured in
      # Security Policy rules.
  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
}
list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves the list of all the managed rulesets available.

Args:
  project: string, Project ID for this request. (required)
  filter: string, A filter expression that filters resources listed in the response. Most
Compute resources support two types of filter expressions:
expressions that support regular expressions and expressions that follow
API improvement proposal AIP-160.
These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The operator
must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.

For example, if you are filtering Compute Engine instances, you can
exclude instances named `example-instance` by specifying
`name != example-instance`.

The `:*` comparison can be used to test whether a key has been defined.
For example, to find all objects with `owner` label use:
```
labels.owner:*
```

You can also filter nested fields. For example, you could specify
`scheduling.automaticRestart = false` to include instances only
if they are not scheduled for automatic restarts. You can use filtering
on nested fields to filter based onresource labels.

To filter on multiple expressions, provide each separate expression within
parentheses. For example:
```
(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")
```
By default, each expression is an `AND` expression. However, you
can include `AND` and `OR` expressions explicitly.
For example:
```
(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)
```

If you want to use a regular expression, use the `eq` (equal) or `ne`
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:

`fieldname eq unquoted literal`
`fieldname eq 'single quoted literal'`
`fieldname eq "double quoted literal"`
`(fieldname1 eq literal) (fieldname2 ne "literal")`

The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.

For example, to filter for instances that do not end with name "instance",
you would use `name ne .*instance`.

You cannot combine constraints on multiple fields using regular
expressions.
  maxResults: integer, The maximum number of results per page that should be returned.
If the number of available results is larger than `maxResults`,
Compute Engine returns a `nextPageToken` that can be used to get
the next page of results in subsequent list requests. Acceptable values are
`0` to `500`, inclusive. (Default: `500`)
  orderBy: string, Sorts list results by a certain order. By default, results
are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation
timestamp using `orderBy="creationTimestamp desc"`. This sorts
results based on the `creationTimestamp` field in
reverse chronological order (newest result first). Use this to sort
resources like operations so that the newest operation is returned first.

Currently, only sorting by `name` or
`creationTimestamp desc` is supported.
  pageToken: string, Specifies a page token to use. Set `pageToken` to the
`nextPageToken` returned by a previous list request to get
the next page of results.
  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a
single zone scope either returns all resources in the zone or no resources,
with an error code.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "id": "A String",
  "items": [
    { # Represents a ManagedRuleset resource.
        #
        # Managed internally by Cloud Armor CLH for Managed Rules features.
        # Customers can only view these resources to modify their Security Policies.
        # For more information, see
        # https://cloud.google.com/armor/docs/.
      "changeLog": "A String", # Output only. [Output Only] The change log for this managed ruleset.
      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339 text format.
      "description": "A String", # [Output Only] An optional description of this resource.
      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
          # defined by the server.
      "name": "A String", # Name of the resource. Generated internally when the resource is created.
          # The name must be 1-63 characters long, and comply withRFC1035.
          # Specifically, the name must be 1-63 characters long and match the regular
          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
          # character must be a lowercase letter, and all following characters must
          # be a dash, lowercase letter, or digit, except the last character, which
          # cannot be a dash.
      "ruleIds": [ # Output only. [Output Only] The list of managed rule IDs that are included in
          # this managed ruleset.
        "A String",
      ],
      "rulesetId": "A String", # Output only. [Output Only] The managed ruleset identifier that can be configured in
          # Security Policy rules.
      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
    },
  ],
  "nextPageToken": "A String",
  "warning": {
    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
        # Engine returns NO_RESULTS_ON_PAGE if there
        # are no results in the response.
    "data": [ # [Output Only] Metadata about this warning in key:
        # value format. For example:
        #
        # "data": [
        #   {
        #    "key": "scope",
        #    "value": "zones/us-east1-d"
        #   }]
      {
        "key": "A String", # [Output Only] A key that provides more detail on the warning being
            # returned. For example, for warnings where there are no results in a list
            # request for a particular zone, this key might be scope and
            # the key value might be the zone name. Other examples might be a key
            # indicating a deprecated resource and a suggested replacement, or a
            # warning about invalid network settings (for example, if an instance
            # attempts to perform IP forwarding but is not enabled for IP forwarding).
        "value": "A String", # [Output Only] A warning data value corresponding to the key.
      },
    ],
    "message": "A String", # [Output Only] A human-readable description of the warning code.
  },
}
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.