| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, h1, h2, h3, div, span, p, pre, a { |
| 5 |
margin: 0; |
| 6 |
padding: 0; |
| 7 |
border: 0; |
| 8 |
font-weight: inherit; |
| 9 |
font-style: inherit; |
| 10 |
font-size: 100%; |
| 11 |
font-family: inherit; |
| 12 |
vertical-align: baseline; |
| 13 |
} |
| 14 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, h2, h3 { |
| 50 |
border-bottom: solid #CCC 1px; |
| 51 |
} |
| 52 |
|
| 53 |
.toc_element { |
| 54 |
margin-top: 0.5em; |
| 55 |
} |
| 56 |
|
| 57 |
.firstline { |
| 58 |
margin-left: 2 em; |
| 59 |
} |
| 60 |
|
| 61 |
.method { |
| 62 |
margin-top: 1em; |
| 63 |
border: solid 1px #CCC; |
| 64 |
padding: 1em; |
| 65 |
background: #EEE; |
| 66 |
} |
| 67 |
|
| 68 |
.details { |
| 69 |
font-weight: bold; |
| 70 |
font-size: 14px; |
| 71 |
} |
| 72 |
|
| 73 |
</style> |
| 74 |
|
| 75 |
<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.dataSourceReferences.html">dataSourceReferences</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#fetchForResourceType">fetchForResourceType(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, resourceType=None, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Fetch DataSourceReferences for a given project, location and resource type.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#fetchForResourceType_next">fetchForResourceType_next()</a></code></p> |
| 85 |
<p class="firstline">Retrieves the next page of results.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Gets details of a single DataSourceReference.</p> |
| 89 |
<p class="toc_element"> |
| 90 |
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 91 |
<p class="firstline">Lists DataSourceReferences for a given project and location.</p> |
| 92 |
<p class="toc_element"> |
| 93 |
<code><a href="#list_next">list_next()</a></code></p> |
| 94 |
<p class="firstline">Retrieves the next page of results.</p> |
| 95 |
<h3>Method Details</h3> |
| 96 |
<div class="method"> |
| 97 |
<code class="details" id="close">close()</code> |
| 98 |
<pre>Close httplib2 connections.</pre> |
| 99 |
</div> |
| 100 |
|
| 101 |
<div class="method"> |
| 102 |
<code class="details" id="fetchForResourceType">fetchForResourceType(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, resourceType=None, x__xgafv=None)</code> |
| 103 |
<pre>Fetch DataSourceReferences for a given project, location and resource type. |
| 104 |
|
| 105 |
Args: |
| 106 |
parent: string, Required. The parent resource name. Format: projects/{project}/locations/{location} (required) |
| 107 |
filter: string, Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename * data_source_backup_config_state * data_source_backup_count * data_source_backup_config_info.last_backup_state * data_source_gcp_resource_info.gcp_resourcename * data_source_gcp_resource_info.type * data_source_gcp_resource_info.location * data_source_gcp_resource_info.cloud_sql_instance_properties.instance_create_time |
| 108 |
orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * name |
| 109 |
pageSize: integer, Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100. |
| 110 |
pageToken: string, Optional. A page token, received from a previous call of `FetchDataSourceReferencesForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDataSourceReferencesForResourceType` must match the call that provided the page token. |
| 111 |
resourceType: string, Required. The type of the Google Cloud resource. Ex: sql.googleapis.com/Instance |
| 112 |
x__xgafv: string, V1 error format. |
| 113 |
Allowed values |
| 114 |
1 - v1 error format |
| 115 |
2 - v2 error format |
| 116 |
|
| 117 |
Returns: |
| 118 |
An object of the form: |
| 119 |
|
| 120 |
{ # Response for the FetchDataSourceReferencesForResourceType method. |
| 121 |
"dataSourceReferences": [ # The DataSourceReferences from the specified parent. |
| 122 |
{ # DataSourceReference is a reference to a DataSource resource. |
| 123 |
"createTime": "A String", # Output only. The time when the DataSourceReference was created. |
| 124 |
"dataSource": "A String", # Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource} |
| 125 |
"dataSourceBackupConfigInfo": { # Information of backup configuration on the DataSource. # Output only. Information of backup configuration on the DataSource. |
| 126 |
"lastBackupState": "A String", # Output only. The status of the last backup in this DataSource |
| 127 |
"lastSuccessfulBackupConsistencyTime": "A String", # Output only. Timestamp of the last successful backup to this DataSource. |
| 128 |
}, |
| 129 |
"dataSourceBackupConfigState": "A String", # Output only. The backup configuration state of the DataSource. |
| 130 |
"dataSourceBackupCount": "A String", # Output only. Number of backups in the DataSource. |
| 131 |
"dataSourceGcpResourceInfo": { # The Google Cloud resource that the DataSource is associated with. # Output only. The Google Cloud resource that the DataSource is associated with. |
| 132 |
"alloyDbClusterProperties": { # AlloyDBClusterDataSourceReferenceProperties represents the properties of an AlloyDB cluster that are stored in the DataSourceReference. # Output only. The properties of the AlloyDB cluster. |
| 133 |
"name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource. Format: projects/{project}/locations/{location}/clusters/{cluster} |
| 134 |
}, |
| 135 |
"cloudSqlInstanceProperties": { # CloudSqlInstanceDataSourceReferenceProperties represents the properties of a Cloud SQL resource that are stored in the DataSourceReference. # Output only. The properties of the Cloud SQL instance. |
| 136 |
"databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance. |
| 137 |
"instanceCreateTime": "A String", # Output only. The instance creation timestamp. |
| 138 |
"instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840` |
| 139 |
"name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance} |
| 140 |
}, |
| 141 |
"filestoreInstanceProperties": { # FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference. . # Output only. The properties of the Filestore instance. |
| 142 |
"instanceCreateTime": "A String", # Output only. The instance creation timestamp. |
| 143 |
"name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. Format: projects/{project}/instances/{instance} |
| 144 |
}, |
| 145 |
"gcpResourcename": "A String", # Output only. The resource name of the Google Cloud resource. Ex: projects/{project}/zones/{zone}/instances/{instance} |
| 146 |
"location": "A String", # Output only. The location of the Google Cloud resource. Ex: //"global"/"unspecified" |
| 147 |
"type": "A String", # Output only. The type of the Google Cloud resource. Ex: compute.googleapis.com/Instance |
| 148 |
}, |
| 149 |
"name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference} |
| 150 |
"totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources for the referenced datasource. |
| 151 |
}, |
| 152 |
], |
| 153 |
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| 154 |
}</pre> |
| 155 |
</div> |
| 156 |
|
| 157 |
<div class="method"> |
| 158 |
<code class="details" id="fetchForResourceType_next">fetchForResourceType_next()</code> |
| 159 |
<pre>Retrieves the next page of results. |
| 160 |
|
| 161 |
Args: |
| 162 |
previous_request: The request for the previous page. (required) |
| 163 |
previous_response: The response from the request for the previous page. (required) |
| 164 |
|
| 165 |
Returns: |
| 166 |
A request object that you can call 'execute()' on to request the next |
| 167 |
page. Returns None if there are no more items in the collection. |
| 168 |
</pre> |
| 169 |
</div> |
| 170 |
|
| 171 |
<div class="method"> |
| 172 |
<code class="details" id="get">get(name, x__xgafv=None)</code> |
| 173 |
<pre>Gets details of a single DataSourceReference. |
| 174 |
|
| 175 |
Args: |
| 176 |
name: string, Required. The name of the DataSourceReference to retrieve. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference} (required) |
| 177 |
x__xgafv: string, V1 error format. |
| 178 |
Allowed values |
| 179 |
1 - v1 error format |
| 180 |
2 - v2 error format |
| 181 |
|
| 182 |
Returns: |
| 183 |
An object of the form: |
| 184 |
|
| 185 |
{ # DataSourceReference is a reference to a DataSource resource. |
| 186 |
"createTime": "A String", # Output only. The time when the DataSourceReference was created. |
| 187 |
"dataSource": "A String", # Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource} |
| 188 |
"dataSourceBackupConfigInfo": { # Information of backup configuration on the DataSource. # Output only. Information of backup configuration on the DataSource. |
| 189 |
"lastBackupState": "A String", # Output only. The status of the last backup in this DataSource |
| 190 |
"lastSuccessfulBackupConsistencyTime": "A String", # Output only. Timestamp of the last successful backup to this DataSource. |
| 191 |
}, |
| 192 |
"dataSourceBackupConfigState": "A String", # Output only. The backup configuration state of the DataSource. |
| 193 |
"dataSourceBackupCount": "A String", # Output only. Number of backups in the DataSource. |
| 194 |
"dataSourceGcpResourceInfo": { # The Google Cloud resource that the DataSource is associated with. # Output only. The Google Cloud resource that the DataSource is associated with. |
| 195 |
"alloyDbClusterProperties": { # AlloyDBClusterDataSourceReferenceProperties represents the properties of an AlloyDB cluster that are stored in the DataSourceReference. # Output only. The properties of the AlloyDB cluster. |
| 196 |
"name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource. Format: projects/{project}/locations/{location}/clusters/{cluster} |
| 197 |
}, |
| 198 |
"cloudSqlInstanceProperties": { # CloudSqlInstanceDataSourceReferenceProperties represents the properties of a Cloud SQL resource that are stored in the DataSourceReference. # Output only. The properties of the Cloud SQL instance. |
| 199 |
"databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance. |
| 200 |
"instanceCreateTime": "A String", # Output only. The instance creation timestamp. |
| 201 |
"instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840` |
| 202 |
"name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance} |
| 203 |
}, |
| 204 |
"filestoreInstanceProperties": { # FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference. . # Output only. The properties of the Filestore instance. |
| 205 |
"instanceCreateTime": "A String", # Output only. The instance creation timestamp. |
| 206 |
"name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. Format: projects/{project}/instances/{instance} |
| 207 |
}, |
| 208 |
"gcpResourcename": "A String", # Output only. The resource name of the Google Cloud resource. Ex: projects/{project}/zones/{zone}/instances/{instance} |
| 209 |
"location": "A String", # Output only. The location of the Google Cloud resource. Ex: //"global"/"unspecified" |
| 210 |
"type": "A String", # Output only. The type of the Google Cloud resource. Ex: compute.googleapis.com/Instance |
| 211 |
}, |
| 212 |
"name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference} |
| 213 |
"totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources for the referenced datasource. |
| 214 |
}</pre> |
| 215 |
</div> |
| 216 |
|
| 217 |
<div class="method"> |
| 218 |
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 219 |
<pre>Lists DataSourceReferences for a given project and location. |
| 220 |
|
| 221 |
Args: |
| 222 |
parent: string, Required. The parent resource name. Format: projects/{project}/locations/{location} (required) |
| 223 |
filter: string, Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=` * data_source_gcp_resource_info.type with `=`, `!=` |
| 224 |
orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename |
| 225 |
pageSize: integer, Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100. |
| 226 |
pageToken: string, Optional. A page token, received from a previous `ListDataSourceReferences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSourceReferences` must match the call that provided the page token. |
| 227 |
x__xgafv: string, V1 error format. |
| 228 |
Allowed values |
| 229 |
1 - v1 error format |
| 230 |
2 - v2 error format |
| 231 |
|
| 232 |
Returns: |
| 233 |
An object of the form: |
| 234 |
|
| 235 |
{ # Response for the ListDataSourceReferences method. |
| 236 |
"dataSourceReferences": [ # The DataSourceReferences from the specified parent. |
| 237 |
{ # DataSourceReference is a reference to a DataSource resource. |
| 238 |
"createTime": "A String", # Output only. The time when the DataSourceReference was created. |
| 239 |
"dataSource": "A String", # Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource} |
| 240 |
"dataSourceBackupConfigInfo": { # Information of backup configuration on the DataSource. # Output only. Information of backup configuration on the DataSource. |
| 241 |
"lastBackupState": "A String", # Output only. The status of the last backup in this DataSource |
| 242 |
"lastSuccessfulBackupConsistencyTime": "A String", # Output only. Timestamp of the last successful backup to this DataSource. |
| 243 |
}, |
| 244 |
"dataSourceBackupConfigState": "A String", # Output only. The backup configuration state of the DataSource. |
| 245 |
"dataSourceBackupCount": "A String", # Output only. Number of backups in the DataSource. |
| 246 |
"dataSourceGcpResourceInfo": { # The Google Cloud resource that the DataSource is associated with. # Output only. The Google Cloud resource that the DataSource is associated with. |
| 247 |
"alloyDbClusterProperties": { # AlloyDBClusterDataSourceReferenceProperties represents the properties of an AlloyDB cluster that are stored in the DataSourceReference. # Output only. The properties of the AlloyDB cluster. |
| 248 |
"name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource. Format: projects/{project}/locations/{location}/clusters/{cluster} |
| 249 |
}, |
| 250 |
"cloudSqlInstanceProperties": { # CloudSqlInstanceDataSourceReferenceProperties represents the properties of a Cloud SQL resource that are stored in the DataSourceReference. # Output only. The properties of the Cloud SQL instance. |
| 251 |
"databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance. |
| 252 |
"instanceCreateTime": "A String", # Output only. The instance creation timestamp. |
| 253 |
"instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840` |
| 254 |
"name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance} |
| 255 |
}, |
| 256 |
"filestoreInstanceProperties": { # FilestoreInstanceDataSourceReferenceProperties represents the properties of a Filestore resource that are stored in the DataSourceReference. . # Output only. The properties of the Filestore instance. |
| 257 |
"instanceCreateTime": "A String", # Output only. The instance creation timestamp. |
| 258 |
"name": "A String", # Output only. Name of the Filestore instance backed up by the datasource. Format: projects/{project}/instances/{instance} |
| 259 |
}, |
| 260 |
"gcpResourcename": "A String", # Output only. The resource name of the Google Cloud resource. Ex: projects/{project}/zones/{zone}/instances/{instance} |
| 261 |
"location": "A String", # Output only. The location of the Google Cloud resource. Ex: //"global"/"unspecified" |
| 262 |
"type": "A String", # Output only. The type of the Google Cloud resource. Ex: compute.googleapis.com/Instance |
| 263 |
}, |
| 264 |
"name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference} |
| 265 |
"totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources for the referenced datasource. |
| 266 |
}, |
| 267 |
], |
| 268 |
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| 269 |
"unreachable": [ # Locations that could not be reached. |
| 270 |
"A String", |
| 271 |
], |
| 272 |
}</pre> |
| 273 |
</div> |
| 274 |
|
| 275 |
<div class="method"> |
| 276 |
<code class="details" id="list_next">list_next()</code> |
| 277 |
<pre>Retrieves the next page of results. |
| 278 |
|
| 279 |
Args: |
| 280 |
previous_request: The request for the previous page. (required) |
| 281 |
previous_response: The response from the request for the previous page. (required) |
| 282 |
|
| 283 |
Returns: |
| 284 |
A request object that you can call 'execute()' on to request the next |
| 285 |
page. Returns None if there are no more items in the collection. |
| 286 |
</pre> |
| 287 |
</div> |
| 288 |
|
| 289 |
</body></html> |