data_source_references
Creates, updates, deletes, gets or lists a data_source_references
resource.
Overview
Name | data_source_references |
Type | Resource |
Id | google.backupdr.data_source_references |
Fields
The following fields are returned by SELECT
queries:
- get
- fetch_for_resource_type
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference} |
createTime | string (google-datetime) | Output only. The time when the DataSourceReference was created. |
dataSource | string | Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource} |
dataSourceBackupConfigInfo | object | Output only. Information of backup configuration on the DataSource. (id: DataSourceBackupConfigInfo) |
dataSourceBackupConfigState | string | Output only. The backup configuration state of the DataSource. |
dataSourceBackupCount | string (int64) | Output only. Number of backups in the DataSource. |
dataSourceGcpResourceInfo | object | Output only. The GCP resource that the DataSource is associated with. (id: DataSourceGcpResourceInfo) |
Successful response
Name | Datatype | Description |
---|---|---|
dataSourceReferences | array | The DataSourceReferences from the specified parent. |
nextPageToken | 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. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | projectsId , locationsId , dataSourceReferencesId | Gets details of a single DataSourceReference. | |
fetch_for_resource_type | select | projectsId , locationsId | resourceType , pageSize , pageToken , filter , orderBy | Fetch DataSourceReferences for a given project, location and resource type. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
dataSourceReferencesId | string | |
locationsId | string | |
projectsId | string | |
filter | string | |
orderBy | string | |
pageSize | integer (int32) | |
pageToken | string | |
resourceType | string |
SELECT
examples
- get
- fetch_for_resource_type
Gets details of a single DataSourceReference.
SELECT
name,
createTime,
dataSource,
dataSourceBackupConfigInfo,
dataSourceBackupConfigState,
dataSourceBackupCount,
dataSourceGcpResourceInfo
FROM google.backupdr.data_source_references
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataSourceReferencesId = '{{ dataSourceReferencesId }}' -- required;
Fetch DataSourceReferences for a given project, location and resource type.
SELECT
dataSourceReferences,
nextPageToken
FROM google.backupdr.data_source_references
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND resourceType = '{{ resourceType }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';