| <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.dataSourceReferences.html">dataSourceReferences</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="#fetchForResourceType">fetchForResourceType(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, resourceType=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Fetch DataSourceReferences for a given project, location and resource type.</p> |
| <p class="toc_element"> |
| <code><a href="#fetchForResourceType_next">fetchForResourceType_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a single DataSourceReference.</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="fetchForResourceType">fetchForResourceType(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, resourceType=None, x__xgafv=None)</code> |
| <pre>Fetch DataSourceReferences for a given project, location and resource type. |
| |
| Args: |
| parent: string, Required. The parent resource name. Format: projects/{project}/locations/{location} (required) |
| 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 |
| 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 |
| 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. |
| 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. |
| resourceType: string, Required. The type of the GCP resource. Ex: sql.googleapis.com/Instance |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for the FetchDataSourceReferencesForResourceType method. |
| "dataSourceReferences": [ # The DataSourceReferences from the specified parent. |
| { # DataSourceReference is a reference to a DataSource resource. |
| "createTime": "A String", # Output only. The time when the DataSourceReference was created. |
| "dataSource": "A String", # Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource} |
| "dataSourceBackupConfigInfo": { # Information of backup configuration on the DataSource. # Output only. Information of backup configuration on the DataSource. |
| "lastBackupState": "A String", # Output only. The status of the last backup in this DataSource |
| "lastSuccessfulBackupConsistencyTime": "A String", # Output only. Timestamp of the last successful backup to this DataSource. |
| }, |
| "dataSourceBackupConfigState": "A String", # Output only. The backup configuration state of the DataSource. |
| "dataSourceBackupCount": "A String", # Output only. Number of backups in the DataSource. |
| "dataSourceGcpResourceInfo": { # The GCP resource that the DataSource is associated with. # Output only. The GCP resource that the DataSource is associated with. |
| "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. |
| "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance. |
| "instanceCreateTime": "A String", # Output only. The instance creation timestamp. |
| "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840` |
| "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance} |
| }, |
| "gcpResourcename": "A String", # Output only. The resource name of the GCP resource. Ex: projects/{project}/zones/{zone}/instances/{instance} |
| "location": "A String", # Output only. The location of the GCP resource. Ex: //"global"/"unspecified" |
| "type": "A String", # Output only. The type of the GCP resource. Ex: compute.googleapis.com/Instance |
| }, |
| "name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference} |
| }, |
| ], |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="fetchForResourceType_next">fetchForResourceType_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 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets details of a single DataSourceReference. |
| |
| Args: |
| name: string, Required. The name of the DataSourceReference to retrieve. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # DataSourceReference is a reference to a DataSource resource. |
| "createTime": "A String", # Output only. The time when the DataSourceReference was created. |
| "dataSource": "A String", # Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource} |
| "dataSourceBackupConfigInfo": { # Information of backup configuration on the DataSource. # Output only. Information of backup configuration on the DataSource. |
| "lastBackupState": "A String", # Output only. The status of the last backup in this DataSource |
| "lastSuccessfulBackupConsistencyTime": "A String", # Output only. Timestamp of the last successful backup to this DataSource. |
| }, |
| "dataSourceBackupConfigState": "A String", # Output only. The backup configuration state of the DataSource. |
| "dataSourceBackupCount": "A String", # Output only. Number of backups in the DataSource. |
| "dataSourceGcpResourceInfo": { # The GCP resource that the DataSource is associated with. # Output only. The GCP resource that the DataSource is associated with. |
| "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. |
| "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance. |
| "instanceCreateTime": "A String", # Output only. The instance creation timestamp. |
| "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840` |
| "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance} |
| }, |
| "gcpResourcename": "A String", # Output only. The resource name of the GCP resource. Ex: projects/{project}/zones/{zone}/instances/{instance} |
| "location": "A String", # Output only. The location of the GCP resource. Ex: //"global"/"unspecified" |
| "type": "A String", # Output only. The type of the GCP resource. Ex: compute.googleapis.com/Instance |
| }, |
| "name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference} |
| }</pre> |
| </div> |
| |
| </body></html> |
