docs/dyn/workloadmanager_v1.projects.locations.rules.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="workloadmanager_v1.html">Workload Manager API</a> . <a href="workloadmanager_v1.projects.html">projects</a> . <a href="workloadmanager_v1.projects.locations.html">locations</a> . <a href="workloadmanager_v1.projects.locations.rules.html">rules</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, customRulesBucket=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists rules in a given project.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, customRulesBucket=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists rules in a given project.

Args:
  parent: string, Required. The [project] on which to execute the request. The format is: projects/{project_id}/locations/{location} Currently, the pre-defined rules are global available to all projects and all regions (required)
  customRulesBucket: string, The Cloud Storage bucket name for custom rules.
  filter: string, Filter based on primary_category, secondary_category
  pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Mesesage of response of list rules
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
  &quot;rules&quot;: [ # all rules in response
    { # Message represent a rule
      &quot;description&quot;: &quot;A String&quot;, # descrite rule in plain language
      &quot;displayName&quot;: &quot;A String&quot;, # the name display in UI
      &quot;errorMessage&quot;: &quot;A String&quot;, # the message template for rule
      &quot;name&quot;: &quot;A String&quot;, # rule name
      &quot;primaryCategory&quot;: &quot;A String&quot;, # the primary category
      &quot;remediation&quot;: &quot;A String&quot;, # the remediation for the rule
      &quot;revisionId&quot;: &quot;A String&quot;, # Output only. the version of the rule
      &quot;secondaryCategory&quot;: &quot;A String&quot;, # the secondary category
      &quot;severity&quot;: &quot;A String&quot;, # the severity of the rule
      &quot;uri&quot;: &quot;A String&quot;, # the docuement url for the rule
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>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 &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

</body></html>