blob: 227550f879293cc18f08636c705c289e54bcc7cd [file] [log] [blame] [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_v1.html">Backup and DR Service API</a> . <a href="backupdr_v1.projects.html">projects</a> . <a href="backupdr_v1.projects.locations.html">locations</a> . <a href="backupdr_v1.projects.locations.resourceBackupConfigs.html">resourceBackupConfigs</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 ResourceBackupConfigs.</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, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists ResourceBackupConfigs.
Args:
parent: string, Required. The project and location for which to retrieve resource backup configs. Format: &#x27;projects/{project_id}/locations/{location}&#x27;. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. (required)
filter: string, Optional. Filtering results.
orderBy: string, Optional. Hint for how to order the results.
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
pageToken: string, Optional. 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:
{ # Response for ListResourceBackupConfigs.
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
&quot;resourceBackupConfigs&quot;: [ # The list of ResourceBackupConfigs for the specified scope.
{ # ResourceBackupConfig represents a resource along with its backup configurations.
&quot;backupConfigsDetails&quot;: [ # Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.
{ # BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.
&quot;applicableResource&quot;: &quot;A String&quot;, # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the resource that is applicable for the backup configuration. Example: &quot;//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}&quot;
&quot;backupConfigSource&quot;: &quot;A String&quot;, # Output only. The full resource name of the backup config source resource. For example, &quot;//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}&quot; or &quot;//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}&quot;.
&quot;backupConfigSourceDisplayName&quot;: &quot;A String&quot;, # Output only. The display name of the backup config source resource.
&quot;backupDrPlanConfig&quot;: { # BackupDrPlanConfig has additional information about Backup and DR&#x27;s Plan backup configuration. # Backup and DR&#x27;s Backup Plan specific data.
&quot;backupDrPlanRules&quot;: [ # Backup rules of the backup plan resource.
{ # BackupDrPlanRule has rule specific information of the backup plan resource.
&quot;lastSuccessfulBackupTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the latest successful backup created via this backup rule.
&quot;ruleId&quot;: &quot;A String&quot;, # Output only. Unique Id of the backup rule.
},
],
},
&quot;backupDrTemplateConfig&quot;: { # BackupDrTemplateConfig has additional information about Backup and DR&#x27;s Template backup configuration. # Backup and DR&#x27;s Template specific data.
&quot;firstPartyManagementUri&quot;: &quot;A String&quot;, # Output only. The URI of the BackupDr template resource for the first party identity users.
&quot;thirdPartyManagementUri&quot;: &quot;A String&quot;, # Output only. The URI of the BackupDr template resource for the third party identity users.
},
&quot;backupLocations&quot;: [ # The locations where the backups are to be stored.
{ # BackupLocation represents a cloud location where a backup can be stored.
&quot;locationId&quot;: &quot;A String&quot;, # Output only. The id of the cloud location. Example: &quot;us-central1&quot;
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the location.
},
],
&quot;backupVault&quot;: &quot;A String&quot;, # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the backup vault that will store the backups generated through this backup configuration. Example: &quot;//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}&quot;
&quot;latestSuccessfulBackupTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the latest successful backup created via this backup configuration.
&quot;pitrSettings&quot;: { # Point in time recovery settings of the backup configuration resource. # Output only. Point in time recovery settings of the backup configuration resource.
&quot;retentionDays&quot;: 42, # Output only. Number of days to retain the backup.
},
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the backup config resource.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of the backup config resource.
},
],
&quot;backupConfigured&quot;: True or False, # Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}
&quot;targetResource&quot;: &quot;A String&quot;, # Output only. The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType.
&quot;targetResourceDisplayName&quot;: &quot;A String&quot;, # Output only. The human friendly name of the target resource.
&quot;targetResourceLabels&quot;: { # Labels associated with the target resource.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;targetResourceType&quot;: &quot;A String&quot;, # Output only. The type of the target resource.
&quot;uid&quot;: &quot;A String&quot;, # Output only. The unique identifier of the resource backup config.
&quot;vaulted&quot;: True or False, # Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set. set.
},
],
}</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>