blob: b3de01c69f06f5b7ad80b53b2be79f7a39059efd [file] [edit]
<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="backupdr_v1beta.html">Backup and DR Service API</a> . <a href="backupdr_v1beta.projects.html">projects</a> . <a href="backupdr_v1beta.projects.locations.html">locations</a> . <a href="backupdr_v1beta.projects.locations.appliedAutoProtectionPolicies.html">appliedAutoProtectionPolicies</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, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists AppliedAutoProtectionPolicies in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</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, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists AppliedAutoProtectionPolicies in a given project and location.
Args:
parent: string, Required. The project and location for which to retrieve the list of applied policies. Format: projects/{project}/locations/{location} (required)
filter: string, Optional. A filter expression that filters resources listed in the response.
orderBy: string, Optional. An expression that sorts the results in the response.
pageSize: integer, Optional. The maximum number of applied policies to return in a single page.
pageToken: string, Optional. A page token, received from a previous `ListAppliedAutoProtectionPolicies` call.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListAppliedAutoProtectionPolicies.
&quot;appliedAutoProtectionPolicies&quot;: [ # A list of the AppliedAutoProtectionPolicy resources found.
{ # AppliedAutoProtectionPolicy is a read-only view of AutoProtectionPolicy and AutoProtectionPolicyBinding resources that apply to a given workload project.
&quot;backupPlanDetails&quot;: [ # Output only. The set of backup plan configurations, mirroring the backup_plan_details from the source AutoProtectionPolicy. Each element specifies a backup plan for a given resource type.
{ # BackupPlanDetail defines configuration of protection.
&quot;backupPlan&quot;: &quot;A String&quot;, # Required. The resource name of the BackupPlan to apply to resources that match the policy&#x27;s criteria. This backup plan must be in the same location as AutoProtectionPolicy. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
&quot;resourceType&quot;: &quot;A String&quot;, # Required. The type of resource that this policy will automatically protect. For MVP, `compute.googleapis.com/Instance` and `compute.googleapis.com/Disk` are supported.
},
],
&quot;bindingEvaluationSummary&quot;: { # BindingEvaluationSummary contains the summary of the last run of job that applies policy to matching resources for a given binding. # Output only. The summary of the last policy application when the job has run.
&quot;failedResourceCount&quot;: &quot;A String&quot;, # Output only. The number of matching resources whose protection failed during job run.
&quot;matchingResourceCount&quot;: &quot;A String&quot;, # Output only. The number of resources that currently match the policy&#x27;s criteria.
&quot;protectedResourceCount&quot;: &quot;A String&quot;, # Output only. The number of matching resources that are successfully protected.
},
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp indicating when the binding was last created.
&quot;criteria&quot;: { # Criteria specifies a set of criteria for matching resources. # Output only. The criteria resources must meet for this rule to apply. From AutoProtectionPolicy.criteria.
&quot;matchingConditions&quot;: [ # Required. A list of matching conditions that a resource must meet to be protected by the policy.
{ # MatchingCondition specifies a set of conditions for matching resources.
&quot;labelCondition&quot;: { # KeyValuePair defines a key-value pair for matching resource labels. # Optional. A condition that matches resources based on their labels. For MVP, this is limited to a single label match.
&quot;key&quot;: &quot;A String&quot;, # Required. The key of the label to match. This must be in the format `{label_key}`. The key must match the regex Format:`\p{Ll}\p{Lo}{0,62}`.
&quot;values&quot;: [ # Required. The values of the label to match. There will be explicit “OR” between values of array. Each value must be in the format `{label_value}`. The value must match the regex Format: `[\\p{Ll}\\p{Lo}\\p{N}_-]{1,63}`.
&quot;A String&quot;,
],
},
},
],
},
&quot;name&quot;: &quot;A String&quot;, # Identifier. Canonical resource name. Format: projects/{workload-project-number}/locations/{location}/appliedAutoProtectionPolicies/{id}.
&quot;sourceBinding&quot;: &quot;A String&quot;, # Output only. The full resource name of the AutoProtectionPolicyBinding that applies the source policy to a scope including this workload project. e.g., projects/{admin-project}/locations/{location}/autoProtectionPolicies/{policy_id}/autoProtectionPolicyBindings/{binding_id}.
&quot;status&quot;: &quot;A String&quot;, # Output only. The status of the applied auto protection policy.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp indicating when the binding was last modified.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page.
&quot;unreachable&quot;: [ # Unordered list. Locations that could not be reached.
&quot;A String&quot;,
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>